bpt_scraper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2853bd3aee52c47391eb9c1ca53ef7f54b54e0a2
+  data.tar.gz: 5181100de11dc79f1cff0b56a9311ce0f501ff9b
+SHA512:
+  metadata.gz: bbb8822b02396c56d2da3323c6453611c3dcd02fdaaec44de24cb6e37aef23a8089b0eec81e22c7513f588366ddb7fc0eff593ffa434c10ec85f5ae13c4bf105
+  data.tar.gz: 85202839f96600697be1358c7521aede0e379b416eec06cbab28fac1a16439f236beaf440618c1303fa5d01b23d25cc70f092948818086446ae50dd31555e395

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.DS_Store
+
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 120
+
+MethodLength:
+  Max: 35
+
+Metrics/AbcSize:
+  Enabled: false
+
+BlockLength:
+  Max: 70

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joshuabartlett@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bpt_scraper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joshua Bartlett
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# BrownPaperTickets Scraper/API Wrapper
+
+This is a simple wrapper to make interacting with BrownPaperTicket's API much easier. Additionally, scraper utilities, such as creating a session via signing in for interacting with the non-API-accessible portions of the site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bpt_scraper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bpt_scraper
+
+## Usage
+
+To use the API wrapper, start by configuring the `PullFeed` class:
+
+```ruby
+BptScraper::PullFeed.developer_id = your_developer_id
+# and optionally set client/account
+BptScraper::PullFeed.client = your_clients_account_email_address
+```
+
+The `PullFeed` class has methods for the six main API endpoints at BPT:
+- Event List - event_list
+- Date List - date_list
+- Price List - price_list
+- Event Sales - event_sales
+- Date Sales - date_sales
+- Order List - order_list
+
+Here is an example usage:
+
+```ruby
+request = BptScraper::PullFeed.new
+response = request.event_list
+puts response.parsed_response
+```
+
+All API endpoint methods return a [HTTParty](https://github.com/jnunemaker/httparty) response object.
+
+To use the scraper tool's session creator, first configure the `Login` class:
+
+```ruby
+BptScraper::Login.email = your_account_email
+BptScraper::Login.password = your_account_password
+```
+
+Then simply send the request:
+
+```ruby
+request = BptScraper::Login.new
+response = request.create_session
+if response
+    # do something else
+end
+```
+
+Alternatively, you can configure the   `Login` class in the moment:
+
+```ruby
+request = BptScraper::Login.new(
+    email: your_account_email,
+    password: your_account_password
+)
+response = request.create_session
+if response
+    # do something else
+end
+```
+
+## Development
+
+BptScraper uses the [dotenv](https://github.com/bkeepers/dotenv) gem to handle environmental variables. Before running tests, add a `.env` file to the root of the gem directory. In in, set the following three variables:
+
+```
+EMAIL=<your_account_email>
+PASSWORD=<your_account_password>
+DEVELOPER_ID=<your_developer_id>
+```
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Joshua Bartlett/bpt_scraper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bpt_scraper'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bpt_scraper.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bpt_scraper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bpt_scraper'
+  spec.version       = BptScraper::VERSION
+  spec.authors       = ['Joshua Bartlett']
+  spec.email         = ['joshuabartlett@gmail.com']
+
+  spec.summary       = 'A webscraper gem for BrownPaperTickets'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'dotenv', '~> 2.2.1'
+  spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'httparty', '~> 0.15.5'
+end

data/lib/bpt_scraper.rb

@@ -0,0 +1,11 @@
+require 'nokogiri'
+require 'httparty'
+
+require 'bpt_scraper/version'
+require 'bpt_scraper/login'
+require 'bpt_scraper/pull_feed'
+require 'bpt_scraper/helpers'
+
+# Main BPT Module
+module BptScraper
+end

data/lib/bpt_scraper/helpers.rb

@@ -0,0 +1,22 @@
+# Main BPT Module
+module Helpers
+  def missing_options_error(name)
+    raise "BptScraper::#{name} was never given required parameters"
+  end
+
+  def missing_parameters_error(name, parameter)
+    raise "BptScraper::#{name} was never given the required parameter: #{parameter}"
+  end
+
+  def no_developer_id_error
+    raise 'The BPT developer_id is required!'
+  end
+
+  def failed_login_fetch
+    raise 'BptScraper was unable to fetch the Bpt home page'
+  end
+
+  def failed_login_post
+    raise 'BptScraper was unable to create a session'
+  end
+end

data/lib/bpt_scraper/login.rb

@@ -0,0 +1,61 @@
+require 'bpt_scraper/helpers'
+
+# Main BPT module
+module BptScraper
+  # Handles the scraping of the home page for CSRF token from username
+  # input. Additionally handles the POSTing of login info to create a session
+  class Login
+    include Helpers
+    attr_accessor :base_url, :fields, :email, :password
+
+    BASE_URL = 'https://www.brownpapertickets.com/login.html'.freeze
+
+    def initialize(base_url: nil, email: nil, password: nil)
+      self.base_url = base_url || self.class.base_url || BASE_URL
+      self.email = email || self.class.email
+      self.password = password || self.class.password
+      missing_options_error('Login') if (self.email.nil? || self.password.nil?)
+    end
+
+    def create_session
+      self.fields = fetch_login_fields
+      send_login_request
+    end
+
+    class << self
+      attr_accessor :base_url, :fields, :email, :password
+    end
+
+    def self.reset
+      self.base_url = nil
+      self.fields = nil
+      self.email = nil
+      self.password = nil
+    end
+
+    private
+
+    # fetches the login page of BPT to be parsed. BPT's CSRF procedure
+    # involves giving a unique id appended to the name of the input field
+    # e.g. name="email_jn7Y8jgf"
+    def fetch_login_fields
+      response = HTTParty.get(base_url)
+      failed_login_fetch unless response.code == 200
+      email_name = Nokogiri::HTML(response).css('#login_email')[0]['name']
+      password_name = Nokogiri::HTML(response).css('#login_password')[0]['name']
+      { email_name: email_name, password_name: password_name }
+    end
+
+    def send_login_request
+      response = HTTParty.post(
+        base_url,
+        body: {
+          fields[:email_name].to_s => email,
+          fields[:password_name].to_s => password
+        }
+      )
+      failed_login_post unless response.code == 200
+      true
+    end
+  end
+end

data/lib/bpt_scraper/pull_feed.rb

@@ -0,0 +1,104 @@
+require 'bpt_scraper/helpers'
+
+# Main BPT Module
+module BptScraper
+  # Handles the fetching of data from BPTs API
+  class PullFeed
+    include Helpers
+    attr_accessor :developer_id, :client
+
+    def initialize(developer_id: nil, client: nil)
+      self.developer_id = developer_id || self.class.developer_id
+      self.client = client || self.class.client
+      no_developer_id_error if self.developer_id.nil?
+    end
+
+    # returns an HTTParty response object
+    def event_list
+      url = list_url_builder('eventlist')
+      response = fetch_url url
+      response
+    end
+
+    def date_list(event_id: nil, date_id: nil)
+      missing_parameters_error('PullFeed', 'event_id') if event_id.nil?
+      @event_id = event_id
+      @date_id = date_id
+      url = list_url_builder('datelist')
+      response = fetch_url url
+      response
+    end
+
+    def price_list(event_id: nil, date_id: nil, price_id: nil)
+      missing_parameters_error('PullFeed', 'event_id') if event_id.nil?
+      missing_parameters_error('PullFeed', 'date_id') if date_id.nil?
+      @event_id = event_id
+      @date_id = date_id
+      @price_id = price_id
+      url = list_url_builder('pricelist')
+      response = fetch_url url
+      response
+    end
+
+    def event_sales(event_id: nil, current: nil)
+      missing_parameters_error('PullFeed', 'client') if client.nil?
+      @event_id = event_id
+      @current = current
+      url = account_url_builder('eventsales')
+      response = fetch_url url
+      response
+    end
+
+    def date_sales(event_id: nil, date_id: nil)
+      missing_parameters_error('PullFeed', 'client') if client.nil?
+      missing_parameters_error('PullFeed', 'event_id') if event_id.nil?
+      @event_id = event_id
+      @date_id = date_id
+      url = account_url_builder('datesales')
+      response = fetch_url url
+      response
+    end
+
+    def order_list(event_id: nil, date_id: nil)
+      missing_parameters_error('PullFeed', 'client') if client.nil?
+      missing_parameters_error('PullFeed', 'event_id') if event_id.nil?
+      @event_id = event_id
+      @date_id = date_id
+      url = account_url_builder('orderlist')
+      response = fetch_url url
+      response
+    end
+
+    def list_url_builder(endpoint)
+      base_url = "https://www.brownpapertickets.com/api2/#{endpoint}?id=#{developer_id}"
+      base_url += "&client=#{client}" unless client.nil?
+      base_url += "&event_id=#{@event_id}" unless @event_id.nil?
+      base_url += "&date_id=#{@date_id}" unless @date_id.nil?
+      base_url += "&price_id=#{@price_id}" unless @price_id.nil?
+      base_url
+    end
+
+    def account_url_builder(endpoint)
+      base_url = "https://www.brownpapertickets.com/api2/#{endpoint}?id=#{developer_id}"
+      base_url += "&account=#{client}" unless client.nil?
+      base_url += "&event_id=#{@event_id}" unless @event_id.nil?
+      base_url += "&date_id=#{@date_id}" unless @date_id.nil?
+      base_url += "&price_id=#{@price_id}" unless @price_id.nil?
+      base_url += "&current=1" if @only_current
+      base_url
+    end
+
+    def fetch_url(url)
+      HTTParty.get(url)
+    end
+
+    def self.reset
+      self.developer_id = nil
+      self.client = nil
+    end
+
+    class << self
+      attr_accessor :developer_id, :client
+    end
+  end
+end

data/lib/bpt_scraper/version.rb

@@ -0,0 +1,3 @@
+module BptScraper
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: bpt_scraper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Bartlett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.5
+description: 
+email:
+- joshuabartlett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bpt_scraper.gemspec
+- lib/bpt_scraper.rb
+- lib/bpt_scraper/helpers.rb
+- lib/bpt_scraper/login.rb
+- lib/bpt_scraper/pull_feed.rb
+- lib/bpt_scraper/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: A webscraper gem for BrownPaperTickets
+test_files: []