poms 1.2.2 → 2.0.0.a

data/lib/poms/api/uris.rb

@@ -0,0 +1,10 @@
+require 'poms/api/uris/media'
+require 'poms/api/uris/schedule'
+
+module Poms
+  module Api
+    # Contains modules that build uri objects for various api endpoints
+    module Uris
+    end
+  end
+end

data/lib/poms/api/uris/media.rb

@@ -0,0 +1,41 @@
+require 'addressable/uri'
+
+module Poms
+  module Api
+    module Uris
+      # Builds uri's for /media endpoints
+      module Media
+        API_PATH = '/v1/api/media'.freeze
+
+        module_function
+
+        def single(base_uri, mid)
+          uri_for_path(base_uri, "/#{mid}")
+        end
+
+        def multiple(base_uri)
+          uri_for_path(base_uri, '/multiple')
+        end
+
+        def descendants(base_uri, mid)
+          uri_for_path(base_uri, "/#{mid}/descendants")
+        end
+
+        def members(base_uri, mid)
+          uri_for_path(base_uri, "/#{mid}/members")
+        end
+
+        # URI for merged series
+        def redirects(base_uri)
+          uri_for_path(base_uri, '/redirects/')
+        end
+
+        def uri_for_path(base_uri, path)
+          base_uri.merge(path: "#{API_PATH}#{path}")
+        end
+
+        private_class_method :uri_for_path
+      end
+    end
+  end
+end

data/lib/poms/api/uris/schedule.rb

@@ -0,0 +1,28 @@
+require 'addressable/uri'
+
+module Poms
+  module Api
+    module Uris
+      # URI for the /schedule API
+      module Schedule
+        API_PATH = '/v1/api/schedule'.freeze
+
+        module_function
+
+        def now(base_uri, channel)
+          uri_for_path(base_uri, "/channel/#{channel}/now")
+        end
+
+        def next(base_uri, channel)
+          uri_for_path(base_uri, "/channel/#{channel}/next")
+        end
+
+        def uri_for_path(base_uri, path = nil)
+          base_uri.merge(path: "#{API_PATH}#{path}")
+        end
+
+        private_class_method :uri_for_path
+      end
+    end
+  end
+end

data/lib/poms/configuration.rb

@@ -0,0 +1,59 @@
+require 'poms/errors'
+
+module Poms
+  # The configuration is a container for configuration values that control the
+  # Poms gem.
+  class Configuration
+    attr_accessor :key, :origin, :secret, :base_uri
+    attr_reader :credentials
+
+    # The fallback base URI in case none is explicitly specified.
+    DEFAULT_BASE_URI = 'https://rs.poms.omroep.nl'.freeze
+
+    # List of special credential keys that need to be present in order to be
+    # able to use the API.
+    REQUIRED_CREDENTIAL_KEYS = [:key, :origin, :secret].freeze
+
+    # Build a new configuration object, including validations and freezing.
+    #
+    # You probably want to use a block to specify the different configuration
+    # options, but when no block is specified, default values will be read from
+    # the environment.
+    def initialize
+      reset
+      yield self if block_given?
+      validate
+      @credentials = OpenStruct.new(key: key, origin: origin, secret: secret)
+      freeze
+    end
+
+    private
+
+    def validate
+      assert_credentials
+      assert_base_uri
+    end
+
+    def assert_credentials
+      REQUIRED_CREDENTIAL_KEYS.each do |key|
+        next if send(key).present?
+        raise Errors::AuthenticationError, "#{key} must be supplied"
+      end
+    end
+
+    def assert_base_uri
+      base_uri or
+        raise Errors::MissingConfigurationError, 'base_uri must be supplied'
+    end
+
+    def reset
+      @credentials = nil
+      self.key = ENV['POMS_KEY']
+      self.origin = ENV['POMS_ORIGIN']
+      self.secret = ENV['POMS_SECRET']
+      self.base_uri = Addressable::URI.parse(
+        ENV.fetch('POMS_BASE_URI', DEFAULT_BASE_URI)
+      )
+    end
+  end
+end

data/lib/poms/errors.rb

@@ -0,0 +1,26 @@
+module Poms
+  module Errors
+    # Generic Poms error that all other errors inherit from. This allows you to
+    # rescue any exception from this library in your application code.
+    PomsError = Class.new(StandardError)
+
+    # Custom Error class to signal missing authorization attributes
+    AuthenticationError = Class.new(PomsError)
+
+    # Base exception for all Poms-specific HTTP errors.
+    HttpError = Class.new(PomsError)
+
+    # Wrapper exception for dealing with driver-agnostic 404 responses.
+    HttpMissingError = Class.new(HttpError)
+
+    # Wrapper exception for dealing with driver-agnostic 500 responses.
+    HttpServerError = Class.new(HttpError)
+
+    # Custom error than can be used to indicate a required configuration value
+    # is missing.
+    MissingConfigurationError = Class.new(PomsError)
+
+    # Custom error to indicate that the gem has not been configured at all.
+    NotConfigured = Class.new(PomsError)
+  end
+end

data/lib/poms/fields.rb

@@ -1,8 +1,10 @@
+require 'poms/timestamp'
+
 module Poms
   # This module contains functions to extract things from a Poms hash that may
   # be harder to access, or are accessed in multiple places.
   module Fields
-    extend self
+    module_function
 
     # Returns the title, main by default
     def title(item, type = 'MAIN')
@@ -22,6 +24,7 @@ module Poms
     # Extracts the image id from an image hash
     # Expects a hash of just an image from POMS
     def image_id(image)
+      return unless image['imageUri']
       image['imageUri'].split(':').last
     end
 
@@ -31,6 +34,10 @@ module Poms
       image_id(images(item).first)
     end
 
+    def mid(item)
+      item['mid']
+    end
+
     # Returns the revision from a Poms hash.
     def rev(item)
       item['_rev'].to_i
@@ -55,10 +62,24 @@ module Poms
       internetvod = item['predictions']
                     .find { |p| p['platform'] == 'INTERNETVOD' }
       return unless internetvod
-      Poms::Timestamp.convert(internetvod['publishStop'])
+      Timestamp.to_datetime(internetvod['publishStop'])
+    end
+
+    # Returns the position in the parent context if it is present.
+    def position(item)
+      parent = item['memberOf']
+      parent.first['index'] if parent.present?
     end
 
-    private
+    def schedule_events(item)
+      events = item.fetch('scheduleEvents', [])
+      events.map do |event|
+        {
+          'starts_at' => Timestamp.to_datetime(event['start']),
+          'ends_at' => Timestamp.to_datetime(event['start'] + event['duration'])
+        }
+      end
+    end
 
     # Poms has arrays of hashes for some types that have a value and type. This
     # is a way to access those simply.
@@ -76,5 +97,7 @@ module Poms
       return unless res
       res['value']
     end
+
+    private_class_method :value_of_type
   end
 end

data/lib/poms/timestamp.rb

@@ -3,9 +3,16 @@ module Poms
   module Timestamp
     module_function
 
-    def convert(poms_timestamp)
-      return unless poms_timestamp
-      Time.at(poms_timestamp / 1000).to_datetime
+    # Convert unix timestamp in milliseconds to datetime
+    def to_datetime(timestamp)
+      return unless timestamp
+      Time.at(timestamp / 1000).to_datetime
+    end
+
+    # Convert to unix timestamp in milliseconds
+    def to_unix_ms(datetime)
+      return unless datetime
+      datetime.to_i * 1000
     end
   end
 end

data/lib/poms/version.rb

@@ -1,4 +1,4 @@
 # The version
 module Poms
-  VERSION = '1.2.2'
+  VERSION = '2.0.0.a'.freeze
 end

data/poms.gemspec

@@ -2,7 +2,6 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'poms/version'
-require 'rake'
 
 Gem::Specification.new do |spec|
   spec.name          = 'poms'
@@ -14,19 +13,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/brightin/poms'
   spec.license       = 'MIT'
 
-  spec.files         = FileList['lib/**/*.rb', '[A-Z]*', 'spec/**/*'].to_a
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'reek'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'fabrication'
-  spec.add_development_dependency 'rubocop', '~> 0.34.1'
-  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'vcr'
-  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,31 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: poms
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0.a
 platform: ruby
 authors:
 - Tom Kruijsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fabrication
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -112,18 +126,18 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.34.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.34.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,13 +165,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -171,79 +185,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".todo.reek"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/ci-run
+- bin/ci-setup
+- bin/reek
+- bin/rspec
+- bin/rubocop
+- examples/fetch.rb
+- examples/search.rb
 - lib/poms.rb
 - lib/poms/api/auth.rb
+- lib/poms/api/client.rb
+- lib/poms/api/drivers/net_http.rb
+- lib/poms/api/json_client.rb
+- lib/poms/api/pagination_client.rb
 - lib/poms/api/request.rb
-- lib/poms/base.rb
-- lib/poms/broadcast.rb
-- lib/poms/builder.rb
-- lib/poms/builderless/broadcast.rb
-- lib/poms/builderless/clip.rb
-- lib/poms/connect.rb
+- lib/poms/api/response.rb
+- lib/poms/api/search.rb
+- lib/poms/api/uris.rb
+- lib/poms/api/uris/media.rb
+- lib/poms/api/uris/schedule.rb
+- lib/poms/configuration.rb
+- lib/poms/errors.rb
 - lib/poms/fields.rb
-- lib/poms/has_ancestors.rb
-- lib/poms/has_base_attributes.rb
-- lib/poms/merged_series.rb
-- lib/poms/poms_error.rb
-- lib/poms/schedule_event.rb
-- lib/poms/season.rb
-- lib/poms/series.rb
 - lib/poms/timestamp.rb
 - lib/poms/version.rb
-- lib/poms/views.rb
 - poms.gemspec
-- spec/fabricators/poms_fabricator.rb
-- spec/fixtures/poms_broadcast.json
-- spec/fixtures/poms_broadcast_multiple_schedule_events.json
-- spec/fixtures/poms_broadcast_pippi.json
-- spec/fixtures/poms_group.json
-- spec/fixtures/poms_series.json
-- spec/fixtures/poms_single_broadcast_by_channel.json
-- spec/fixtures/poms_zapp.json
-- spec/fixtures/vcr_cassettes/poms/builderless/broadcast_starts_at/returns_a_datetime.yml
-- spec/fixtures/vcr_cassettes/poms/builderless/clip/has_a_position.yml
-- spec/fixtures/vcr_cassettes/poms/builderless/clip/has_a_title.yml
-- spec/fixtures/vcr_cassettes/poms/builderless/clip/has_a_video_url.yml
-- spec/fixtures/vcr_cassettes/poms/builderless/clip/has_an_image_id.yml
-- spec/fixtures/vcr_cassettes/poms/fetch_broadcasts_fetch_current_broadcast_fetches_the_current_broadcast.yml
-- spec/fixtures/vcr_cassettes/poms/fetch_broadcasts_fetch_next_broadcast_and_key_fetches_the_current_broadcast.yml
-- spec/fixtures/vcr_cassettes/poms/fetch_broadcasts_fetch_next_broadcast_and_key_returns_the_key.yml
-- spec/fixtures/vcr_cassettes/poms/merged_series/turns_the_json_into_a_hash.yml
-- spec/fixtures/vcr_cassettes/poms_fetch/a_broadcast_has_scheduled_events_with_last_with_starts_at.yml
-- spec/fixtures/vcr_cassettes/poms_fetch/a_clip_has_a_title.yml
-- spec/fixtures/vcr_cassettes/poms_fetch/an_aankeiler_has_images.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_broadcasts_for_serie/returns_nil_when_a_broadcast_does_not_exist.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast/has_a_mid.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast/has_a_title.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast/has_scheduled_events_with_last_with_starts_at.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast_and_key/has_a_broadcast_with_a_mid.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast_and_key/has_a_key.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_descendant_mids/returns_a_list_of_mids.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_descendants_for_serie/builds_a_list_of_broadcasts.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_group/has_a_child_with_a_media_type.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_group/has_a_child_with_a_title.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_playlist_clips/creates_an_array_of_clips.yml
-- spec/integration/poms_spec.rb
-- spec/lib/poms/api/auth_spec.rb
-- spec/lib/poms/api/request_spec.rb
-- spec/lib/poms/broadcast_spec.rb
-- spec/lib/poms/builder_spec.rb
-- spec/lib/poms/builderless/broadcast_spec.rb
-- spec/lib/poms/builderless/clip_spec.rb
-- spec/lib/poms/fields_spec.rb
-- spec/lib/poms/merged_series_spec.rb
-- spec/lib/poms/schedule_event_spec.rb
-- spec/lib/poms/timestamp_spec.rb
-- spec/lib/poms/views_spec.rb
-- spec/lib/poms_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/brightin/poms
 licenses:
 - MIT
@@ -259,58 +235,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Interface to POMS CouchDB API
-test_files:
-- spec/fabricators/poms_fabricator.rb
-- spec/fixtures/poms_broadcast.json
-- spec/fixtures/poms_broadcast_multiple_schedule_events.json
-- spec/fixtures/poms_broadcast_pippi.json
-- spec/fixtures/poms_group.json
-- spec/fixtures/poms_series.json
-- spec/fixtures/poms_single_broadcast_by_channel.json
-- spec/fixtures/poms_zapp.json
-- spec/fixtures/vcr_cassettes/poms/builderless/broadcast_starts_at/returns_a_datetime.yml
-- spec/fixtures/vcr_cassettes/poms/builderless/clip/has_a_position.yml
-- spec/fixtures/vcr_cassettes/poms/builderless/clip/has_a_title.yml
-- spec/fixtures/vcr_cassettes/poms/builderless/clip/has_a_video_url.yml
-- spec/fixtures/vcr_cassettes/poms/builderless/clip/has_an_image_id.yml
-- spec/fixtures/vcr_cassettes/poms/fetch_broadcasts_fetch_current_broadcast_fetches_the_current_broadcast.yml
-- spec/fixtures/vcr_cassettes/poms/fetch_broadcasts_fetch_next_broadcast_and_key_fetches_the_current_broadcast.yml
-- spec/fixtures/vcr_cassettes/poms/fetch_broadcasts_fetch_next_broadcast_and_key_returns_the_key.yml
-- spec/fixtures/vcr_cassettes/poms/merged_series/turns_the_json_into_a_hash.yml
-- spec/fixtures/vcr_cassettes/poms_fetch/a_broadcast_has_scheduled_events_with_last_with_starts_at.yml
-- spec/fixtures/vcr_cassettes/poms_fetch/a_clip_has_a_title.yml
-- spec/fixtures/vcr_cassettes/poms_fetch/an_aankeiler_has_images.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_broadcasts_for_serie/returns_nil_when_a_broadcast_does_not_exist.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast/has_a_mid.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast/has_a_title.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast/has_scheduled_events_with_last_with_starts_at.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast_and_key/has_a_broadcast_with_a_mid.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_current_broadcast_and_key/has_a_key.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_descendant_mids/returns_a_list_of_mids.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_descendants_for_serie/builds_a_list_of_broadcasts.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_group/has_a_child_with_a_media_type.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_group/has_a_child_with_a_title.yml
-- spec/fixtures/vcr_cassettes/poms_fetch_playlist_clips/creates_an_array_of_clips.yml
-- spec/integration/poms_spec.rb
-- spec/lib/poms/api/auth_spec.rb
-- spec/lib/poms/api/request_spec.rb
-- spec/lib/poms/broadcast_spec.rb
-- spec/lib/poms/builder_spec.rb
-- spec/lib/poms/builderless/broadcast_spec.rb
-- spec/lib/poms/builderless/clip_spec.rb
-- spec/lib/poms/fields_spec.rb
-- spec/lib/poms/merged_series_spec.rb
-- spec/lib/poms/schedule_event_spec.rb
-- spec/lib/poms/timestamp_spec.rb
-- spec/lib/poms/views_spec.rb
-- spec/lib/poms_spec.rb
-- spec/spec_helper.rb
+test_files: []