bfi_player_search 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb3485213ce0966d67e48e710b21139558dc9354
+  data.tar.gz: 932e718ec4dccb5e6a8f3d571d8d72f727002370
+SHA512:
+  metadata.gz: 43b6362b34288678f810c0bae5be57427531788d4e046fc80dc7cbc57e150e1c839af345739552ecd07bca42f9cf796539949e3a7712f49237617d629e20d64d
+  data.tar.gz: cc5089280d6dc96eca3bfe0e7ee6b7a2d16e33b83ff15b341b982a92bbe7769a7f3d851c881511bdab8fa3d126058fc58e651f53a19e230d2ab61bf1ed329d57

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joel Chippindale
+
+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/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/bfi_player_search/result_parser.rb

@@ -0,0 +1,48 @@
+module BFIPlayerSearch
+  class ResultParser
+    def initialize(fragment)
+      @fragment = fragment
+    end
+
+    def title
+      fragment.css('span.title').first.content.strip
+    end
+
+    def year
+      if year_tag = fragment.css('span.film-year').first
+        year_tag.content.strip
+      end
+    end
+
+    def certificate
+      if cert_tag = fragment.css('img.certificate-image').first
+        cert_tag.attributes['alt'].to_s.strip
+      end
+    end
+
+    def free?
+      fragment.css('.price').first.content.include?('free')
+    end
+
+    def url
+      path = fragment.css('a').first.attributes['href'].to_s.strip
+      convert_to_url(path)
+    end
+
+    def image_url
+      path = fragment.css('figure img').first.attributes['src'].to_s.strip
+      convert_to_url(path)
+    end
+
+    private
+    attr_reader :fragment
+
+    def convert_to_url(path_or_url)
+      u = URI.parse(path_or_url)
+      u.host ||= 'player.bfi.org.uk'
+      u.scheme ||= 'http'
+      u.to_s
+    end
+  end
+end
+

data/lib/bfi_player_search/search.rb

@@ -0,0 +1,41 @@
+require 'uri'
+require 'nokogiri'
+require 'httpclient'
+
+module BFIPlayerSearch
+  class Search
+    def search(query)
+      r = response(query)
+      films = film_fragments(r.body).map do |f|
+        rp = ResultParser.new(f)
+        {
+          :title => rp.title,
+          :url => rp.url,
+          :image_url => rp.image_url,
+          :year => rp.year,
+          :certificate => rp.certificate,
+          :free => rp.free?
+        }
+      end
+
+      if films.empty? & !no_results_page?(r.body)
+        raise BFIPlayerSearch::SearchResultsPageNotRecognised
+      else
+        films
+      end
+    end
+
+    private
+    def no_results_page?(page)
+      page.include?('returned no results')
+    end
+
+    def response(query)
+      HTTPClient.new.get('http://player.bfi.org.uk/search/', { 'q' => query })
+    end
+
+    def film_fragments(page)
+      Nokogiri::HTML(page).css('#search-results article.film')
+    end
+  end
+end

data/lib/bfi_player_search/search_results_page_not_recognised.rb

@@ -0,0 +1,4 @@
+module BFIPlayerSearch
+  class SearchResultsPageNotRecognised < StandardError
+  end
+end

data/lib/bfi_player_search.rb

@@ -0,0 +1,4 @@
+require 'bfi_player_search/search_results_page_not_recognised'
+require 'bfi_player_search/result_parser'
+require 'bfi_player_search/search'
+

data/spec/feature/search_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'A search' do
+  context 'with zero results', :vcr do
+    it { expect(BFIPlayerSearch::Search.new.search('qqqqqqqqqqqqqqqqq')).to be_empty }
+  end
+
+  context 'with some results', :vcr do
+    subject { BFIPlayerSearch::Search.new.search('girl') }
+
+    it { expect(subject).to_not be_empty }
+    it { expect(subject.first[:title]).to_not be_empty }
+    it { expect(subject.first[:url]).to match(%r{^http://player.bfi.org.uk/film/watch-.*}) }
+    it { expect(subject.first[:image_url]).to match(%r{^http://player.bfi.org.uk//media/images/stills/film/.*\.jpg}) }
+  end
+
+  context 'with unrecognised page format returned' do
+    before do
+      VCR.turn_off!
+
+      stub_request(:get, 'http://player.bfi.org.uk/search/?q=girl').
+        to_return(:body => '<html><body><h1>Not what you expected</h1></body></html>')
+    end
+
+    after do
+      VCR.turn_on!
+    end
+
+    it do
+      expect {
+        BFIPlayerSearch::Search.new.search('girl') 
+      }.to raise_error(BFIPlayerSearch::SearchResultsPageNotRecognised)
+    end
+  end
+end

data/spec/lib/bfi_player_search/result_parser_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe BFIPlayerSearch::ResultParser do
+  let(:title) { 'The 39 Steps' }
+  let(:year) { '1935' }
+  let(:certificate) { 'U' }
+  let(:url) { 'http://player.bfi.org.uk/film/watch-the-39-steps-1935/' }
+  let(:image_url) { 'http://player.bfi.org.uk//media/images/stills/film/6865/0f6237fc6f0a145a72ffa136a7ad88f6-320x180.jpg' }
+  let(:fragment) {
+    Nokogiri::HTML::DocumentFragment.parse("<article class='film'>
+      <a href='/film/watch-the-39-steps-1935/'>View The 39 Steps </a>
+      <figure>
+        <img src='//player.bfi.org.uk//media/images/stills/film/6865/0f6237fc6f0a145a72ffa136a7ad88f6-320x180.jpg'>
+      </figure>
+      <div class='film-preview'>
+        <div class='price'></div>
+        <h3 class='film-title'>
+          <span class='title'>#{title} </span>
+          <span class='film-year'>#{year}</span>
+          <img class='certificate-image' alt='#{certificate}'>
+        </h3>
+      </div>
+    </article>")
+  }
+
+  subject { BFIPlayerSearch::ResultParser.new(fragment) }
+
+  describe '#title' do
+    it { expect(subject.title).to eq(title) }
+  end
+
+  describe '#url' do
+    it { expect(subject.url).to eq(url) }
+  end
+
+  describe '#image_url' do
+    it { expect(subject.image_url).to eq(image_url) }
+  end
+
+  describe '#year' do
+    it { expect(subject.year).to eq(year) }
+
+    context 'without year' do
+      let(:fragment) {
+        Nokogiri::HTML::DocumentFragment.parse("<article class='film'>
+          <div class='film-preview'>
+            <h3 class='film-title'>
+            </h3>
+          </div>
+        </article>")
+      }
+
+      subject { BFIPlayerSearch::ResultParser.new(fragment) }
+
+      it { expect(subject.year).to be_nil }
+    end
+  end
+
+  describe '#certificate' do
+    it { expect(subject.certificate).to eq(certificate) }
+
+    context 'without certificate' do
+      let(:fragment) {
+        Nokogiri::HTML::DocumentFragment.parse("<article class='film'>
+          <div class='film-preview'>
+            <h3 class='film-title'>
+            </h3>
+          </div>
+        </article>")
+      }
+
+      subject { BFIPlayerSearch::ResultParser.new(fragment) }
+
+      it { expect(subject.certificate).to be_nil }
+    end
+  end
+
+  describe '#free?' do
+    it { expect(subject).to_not be_free }
+
+    context 'when free' do
+      let(:fragment) {
+        Nokogiri::HTML::DocumentFragment.parse("<article class='film'>
+          <div class='film-preview'>
+            <div class='price'> Watch for free </div>
+            <h3 class='film-title'>
+            </h3>
+          </div>
+        </article>")
+      }
+
+      subject { BFIPlayerSearch::ResultParser.new(fragment) }
+
+      it { expect(subject).to be_free }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,106 @@
+require 'vcr'
+require 'webmock/rspec'
+require 'bfi_player_search'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: bfi_player_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joel Chippindale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+description: Built with some wonky page scraping
+email: joel@joelchippindale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- Rakefile
+- lib/bfi_player_search.rb
+- lib/bfi_player_search/result_parser.rb
+- lib/bfi_player_search/search.rb
+- lib/bfi_player_search/search_results_page_not_recognised.rb
+- spec/feature/search_spec.rb
+- spec/lib/bfi_player_search/result_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mocoso/bfi_player_search
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A simple search API for BFI player
+test_files: []