# crowd_funding_parser

**Repository Path**: rubygems/crowd_funding_parser

## Basic Information

- **Project Name**: crowd_funding_parser
- **Description**: No description available
- **Primary Language**: Ruby
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-10-14
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/BackerFounder/crowd_funding_parser.svg)](https://travis-ci.org/BackerFounder/crowd_funding_parser)

# CrowdFundingParser

TODO: Write a gem description

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'crowd_funding_parser'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install crowd_funding_parser

## Usage

You can use it to get single project's attributes, listed below (sometimes just some of them):

1. ```project id(platform_project_id)```
2. ```title```
3. ```category```
4. ```creator_name```
5. ```creator_id```
6. ```creator_link```
7. ```summary```
8. ```start_date```
9. ```end_date```
10. ```region```
11. ```currency_string```
12. ```money_goal```
13. ```money_pledged```
14. ```backer_count```
15. ```left_time```
16. ```status```
17. ```fb_count```
18. ```following_count```

by using:

```ruby
    flyingv_parser = CrowdFundingParser::Parser::Flyingv.new
    project_data = flyingv_parser.get_project(PROJECT_URL)
```

Or you can use it to get all project's links, using

```ruby
    flyingv_parser = CrowdFundingParser::Parser::Flyingv.new
    project_links = flyingv_parser.get_project_links(STATUS) # "finished" or "online"
```

## Contributing

1. Fork it ( https://github.com/[my-github-username]/crowd_funding_parser/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

### Add New Parser

#### 1. Add Test

##### What to test

There should be 18 methods that need to be tested:

1. ```get_id```
2. ```get_title```
3. ```get_category```
4. ```get_creator_name```
5. ```get_creator_id```
6. ```get_creator_link```
7. ```get_summary```
8. ```get_start_date```
9. ```get_end_date```
10. ```get_region```
11. ```get_currency_string```
12. ```get_money_goal```
13. ```get_money_pledged```
14. ```get_backer_count```
15. ```get_left_time```
16. ```get_status```
17. ```get_fb_count```
18. ```get_following_count```

##### How to write a test

1. Use `get_project_doc(campaign_page_url, platform_name)` to get test doc (please use a finished project).
2. Set expectations as the project's attributes (use `""` if can't get that attribute).
3. [Example spec](https://github.com/BackerFounder/crowd_funding_parser/blob/master/spec/parsers/flyingv_spec.rb).

##### How to run test

We use `Rspec` to run our test, so just run `bundle exec rspec`.
Or you can run `bundle exec guard` to automatically run tests whenever you changed spec.


#### Add Parser(only deal with single project's data parsing)

1. Place your parser in `lib/crowd_funding_parsers/parser`
2. Naming your parser class after its platform's name
3. Write parser in `MethodBuilder.set_methods` block:

  1. use `insert_parser` method to register your parser class in method_builder
  2. use `set_variable` to set variables you need to use in parser methods, like `@platform_url`
  3. use `set_method` to define method
  4. if you need to use methods you set in method_builder, call it with `@parser` variable.

4. [Example parser](https://github.com/BackerFounder/crowd_funding_parser/blob/master/lib/crowd_funding_parser/parser/flyingv.rb)