poms 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f974c08408f4d51d55403210e099410fd2030fea
-  data.tar.gz: a8621cc51d99c4257639d45addec5c55f4170d0f
+  metadata.gz: d81f89d00205f5c4f952366d4c11de426b71fa6c
+  data.tar.gz: 5c4e1d1f5dd4f51f5020b67e2004b815e41dcc57
 SHA512:
-  metadata.gz: 4b0f22e2f765d73fcbe1ab67be1003f7b328c21181ebf3006d20a05a5f16049a17e63d75cdd95bc8af09229b2b4f05d16785a916115460c2adcbc790b3528578
-  data.tar.gz: 0a6bd52ccd8123d5da464c1406599b7f182e0cb216b75032640c92e5d2c7ec4830ebc7f19c26240ef517d93ec5482339642c38935f368cc7d31514d086e990da
+  metadata.gz: dac6d2dec0643d289b446dc354bf603fb20332753d238310ccd722d1ce42865f0a2208162d5961d67562b7fc79e252fdde8746bbeca92bb5fcddb552128e47f9
+  data.tar.gz: 14b9288eed88d253cc9361b3638784154c6ac8d33550ca949f7b602ff3ece90800578e4d142fe11729ed27b95e63970a98a316ab207c29b4a36b9bfa814f2285

data/.rubocop.yml

@@ -32,3 +32,21 @@ ModuleLength:
 
 RSpec/ExampleLength:
   Max: 15
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/FirstParameterIndentation:
+  EnforcedStyle: consistent
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Poms Release notes
 
+## 2.2.0
+
+* Remove `Poms::Fields#rev` as it wasn't provided by the Poms data anyway.
+* Add helper methods for NICAM ratings.
+
 ## 2.1.3
 
 * Order images array by likelyhood of a higher quality image (type: PROMO_LANDSCAPE > PICTURE > STILL).

data/circle.yml

@@ -8,5 +8,4 @@ machine:
 test:
   override:
     - bundle exec rubocop
-    - bundle exec reek
     - bundle exec rspec

data/examples/search.rb

@@ -1,17 +1,9 @@
 require 'poms'
 
-# You can build a search params hash using Poms::Api::Search
-query = Poms::Api::Search.build(starts_at: Time.now, ends_at: 2.weeks.from_now)
-
-# And use it to query the poms API
-Poms.descendants('VPWON_1251179', query)
+Poms.descendants('VPWON_1251179', starts_at: Time.now, ends_at: 2.days.from_now)
 # => Returns all media that is a descendant of the media by the given mid, and
 # was broadcasted between now and next week
 
-# This example will fetch all media that is of type "BROADCAST"
-query = Poms::Api::Search.build(starts_at: Time.now, type: 'BROADCAST')
-
-# Use it
-Poms.descendants('VPWON_1251179', query)
+Poms.descendants('VPWON_1251179', starts_at: Time.now, type: 'BROADCAST')
 # => Returns all media that is a descendant of the media by the given mid, has
 # not aired yet and is a broadcast

data/lib/poms.rb

@@ -2,6 +2,7 @@ require 'active_support/all'
 require 'poms/api/uris'
 require 'poms/api/json_client'
 require 'poms/api/pagination_client'
+require 'poms/api/request'
 require 'poms/errors'
 require 'poms/api/search'
 require 'poms/configuration'
@@ -40,33 +41,31 @@ module Poms
   # @param [String] mid
   # @raise Api::Client::HttpMissingError
   def first!(mid)
-    Api::JsonClient.get(
-      Api::Uris::Media.single(config.base_uri, mid),
-      config.credentials
-    )
+    Api::JsonClient.execute(build_request(
+      uri: Api::Uris::Media.single(config.base_uri, mid)
+    ))
   end
 
   def fetch(arg)
-    Api::JsonClient.post(
-      Api::Uris::Media.multiple(config.base_uri),
-      Array(arg),
-      config.credentials
-    )
+    Api::JsonClient.execute(build_request(
+      method: :post,
+      uri: Api::Uris::Media.multiple(config.base_uri),
+      body: Array(arg)
+    ))
   end
 
   def descendants(mid, search_params = {})
-    Api::PaginationClient.post(
-      Api::Uris::Media.descendants(config.base_uri, mid),
-      Api::Search.build(search_params),
-      config.credentials
-    )
+    Api::PaginationClient.execute(build_request(
+      method: :post,
+      uri: Api::Uris::Media.descendants(config.base_uri, mid),
+      body: Api::Search.build(search_params)
+    ))
   end
 
   def members(mid)
-    Api::PaginationClient.get(
-      Api::Uris::Media.members(config.base_uri, mid),
-      config.credentials
-    )
+    Api::PaginationClient.execute(build_request(
+      uri: Api::Uris::Media.members(config.base_uri, mid)
+    ))
   end
 
   # Gets the merged serie mids as a hash. Expects a JSON response from
@@ -74,30 +73,27 @@ module Poms
   #
   # @return [Hash] a hash with old_mid => new_mid pairs
   def merged_series
-    Api::JsonClient.get(
-      Api::Uris::Media.redirects(config.base_uri),
-      config
-    ).fetch('map')
+    Api::JsonClient.execute(build_request(
+      uri: Api::Uris::Media.redirects(config.base_uri)
+    )).fetch('map')
   end
 
   # Fetches the event for current broadcast on the given channel
   #
   # @param channel The channel name
   def scheduled_now(channel)
-    Poms::Api::JsonClient.get(
-      Poms::Api::Uris::Schedule.now(config.base_uri, channel),
-      config.credentials
-    ).fetch('items').first
+    Api::JsonClient.execute(build_request(
+      uri: Api::Uris::Schedule.now(config.base_uri, channel)
+    )).fetch('items').first
   end
 
   # Fetches the event for the next broadcast on a given channel
   #
   # @param channel The channel name
   def scheduled_next(channel)
-    Poms::Api::JsonClient.get(
-      Poms::Api::Uris::Schedule.next(config.base_uri, channel),
-      config.credentials
-    ).fetch('items').first
+    Api::JsonClient.execute(build_request(
+      uri: Api::Uris::Schedule.next(config.base_uri, channel)
+    )).fetch('items').first
   end
 
   def reset_config
@@ -108,5 +104,9 @@ module Poms
     @config or raise Errors::NotConfigured
   end
 
-  private_class_method :config
+  def build_request(attributes)
+    Api::Request.new(attributes.merge(credentials: config.credentials))
+  end
+
+  private_class_method :config, :build_request
 end

data/lib/poms/api/auth.rb

@@ -9,27 +9,25 @@ module Poms
     module Auth
       module_function
 
-      extend SingleForwardable
-
-      delegate %i(origin secret key) => :@credentials
-
       # @param request The prepared request
       # @param credentials The Poms API credentials
       # @param clock Defaults to current time, but can be provided as Time
-      def sign(request, credentials, clock = Time.now)
-        @credentials = credentials
+      def sign(request, clock = Time.now)
+        credentials = request.credentials
         timestamp = clock.rfc822
-        message = generate_message(request.uri, timestamp)
-
-        request['Origin'] = origin
-        request['X-NPO-Date'] = timestamp
-        request['Authorization'] = "NPO #{key}:#{encrypt(message)}"
-        request
+        message = generate_message(request, timestamp)
+        auth = "NPO #{credentials.key}:#{encrypt(credentials.secret, message)}"
+
+        request.merge(headers: request.headers.merge(
+          'Origin' => credentials.origin,
+          'X-NPO-Date' => timestamp,
+          'Authorization' => auth
+        ))
       end
 
       # Create a message for the Authorization header. This is an encrypted
       # stringconsisting of a message that is hashed with a shared secret.
-      def encrypt(message)
+      def encrypt(secret, message)
         sha256 = OpenSSL::Digest.new('sha256')
         digest = OpenSSL::HMAC.digest(sha256, secret, message)
         Base64.encode64(digest).strip
@@ -39,12 +37,12 @@ module Poms
       # documentation.
       # @param uri The Addressable::URI
       # @param timestamp An rfc822 formatted timestamp
-      def generate_message(uri, timestamp)
+      def generate_message(request, timestamp)
         [
-          "origin:#{origin}",
+          "origin:#{request.credentials.origin}",
           "x-npo-date:#{timestamp}",
-          "uri:#{uri.path}",
-          params_string(uri.query_values)
+          "uri:#{request.uri.path}",
+          params_string(request.uri.query_values)
         ].compact.join(',')
       end
 

data/lib/poms/api/client.rb

@@ -11,30 +11,10 @@ module Poms
     #
     # @see Poms::Api::Drivers::NetHttp
     module Client
-      extend Drivers::NetHttp
-
       module_function
 
-      def get(uri, credentials, headers = {})
-        handle_response(
-          execute(
-            Auth.sign(
-              prepare_get(uri, headers),
-              credentials
-            )
-          )
-        )
-      end
-
-      def post(uri, body, credentials, headers = {})
-        handle_response(
-          execute(
-            Auth.sign(
-              prepare_post(uri, body, headers),
-              credentials
-            )
-          )
-        )
+      def execute(request)
+        handle_response(Drivers::NetHttp.execute(Auth.sign(request)))
       end
 
       def handle_response(response)
@@ -45,14 +25,6 @@ module Poms
           response
         end
       end
-
-      def prepare_get(uri, headers = {})
-        Request.get(uri, nil, headers)
-      end
-
-      def prepare_post(uri, body, headers = {})
-        Request.post(uri, body, headers)
-      end
     end
   end
 end

data/lib/poms/api/drivers/net_http.rb

@@ -23,6 +23,8 @@ module Poms
           Net::ProtocolError
         ].freeze
 
+        module_function
+
         def execute(request_description)
           response = attempt_request(
             request_description.uri,
@@ -31,8 +33,6 @@ module Poms
           Response.new(response.code, response.body, response.to_hash)
         end
 
-        private
-
         def attempt_request(uri, request)
           Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
             http.open_timeout = 5
@@ -41,13 +41,13 @@ module Poms
           end
         rescue *NET_HTTP_ERRORS => e
           raise Errors::HttpError,
-                "An error (#{e.class}) occured while processing your request."
+            "An error (#{e.class}) occured while processing your request."
         end
 
         def prepare_request(request_description)
           request = request_to_net_http_request(request_description)
           request.body = request_description.body.to_s
-          request_description.each_header do |key, value|
+          request_description.headers.each do |key, value|
             request[key] = value
           end
           request
@@ -63,6 +63,9 @@ module Poms
             raise ArgumentError, 'can only execute GET or POST requests'
           end
         end
+
+        private_class_method :attempt_request, :prepare_request,
+          :request_to_net_http_request
       end
     end
   end

data/lib/poms/api/json_client.rb

@@ -12,23 +12,12 @@ module Poms
 
       module_function
 
-      def get(uri, credentials, headers = {})
-        response = Client.get(
-          uri,
-          credentials,
-          DEFAULT_HEADERS.merge(headers)
+      def execute(request)
+        request = request.merge(
+          body: request.body.to_json,
+          headers: DEFAULT_HEADERS.merge(request.headers)
         )
-        JSON.parse(response.body)
-      end
-
-      def post(uri, body, credentials, headers = {})
-        response = Client.post(
-          uri,
-          body.to_json,
-          credentials,
-          DEFAULT_HEADERS.merge(headers)
-        )
-        JSON.parse(response.body)
+        JSON.parse(Client.execute(request).body)
       end
     end
   end

data/lib/poms/api/pagination_client.rb

@@ -1,4 +1,5 @@
 require 'poms/api/json_client'
+require 'poms/api/request'
 
 module Poms
   module Api
@@ -7,23 +8,11 @@ module Poms
     module PaginationClient
       module_function
 
-      def get(uri, credentials)
-        execute(uri) do |page_uri|
-          Api::JsonClient.get(page_uri, credentials)
-        end
-      end
-
-      def post(uri, body, credentials)
-        execute(uri) do |page_uri|
-          Api::JsonClient.post(page_uri, body, credentials)
-        end
-      end
-
-      def execute(uri)
+      def execute(request)
         Enumerator.new do |yielder|
-          page = Page.new(uri)
+          page = Page.new(request.uri)
           loop do
-            page.execute { |page_uri| yield page_uri }
+            page.execute { |page_uri| client_execute(request, page_uri) }
             page.items.each { |item| yielder << item }
             raise StopIteration if page.final?
             page = page.next_page
@@ -31,6 +20,12 @@ module Poms
         end.lazy
       end
 
+      def client_execute(request, page_uri)
+        Api::JsonClient.execute(request.merge(uri: page_uri))
+      end
+
+      private_class_method :client_execute
+
       # Keep track of number of items and how many have been retrieved
       class Page
         def initialize(uri, offset = 0)

data/lib/poms/api/request.rb

@@ -6,28 +6,32 @@ module Poms
     # request, representing a combination of an HTTP method, URI, body and
     # headers.
     class Request
-      extend Forwardable
-      def_delegators :@headers, :[], :[]=
-      def_delegator :@headers, :each, :each_header
+      attr_reader :method, :uri, :credentials, :body, :headers
 
-      attr_reader :uri, :body
-
-      def self.get(*args)
-        new(:get, *args)
+      def initialize(
+        uri:, method: :get, credentials: nil, body: nil, headers: {}
+      )
+        @uri = uri
+        @method = method.to_sym
+        @body = body || ''
+        @headers = headers.to_h.freeze
+        @credentials = credentials
+        validate!
+        freeze
       end
 
-      def self.post(*args)
-        new(:post, *args)
+      def merge(new_attributes)
+        self.class.new(attributes.merge(new_attributes))
       end
 
-      def initialize(method, uri, body = nil, headers = {})
-        @method = method.to_sym
-        unless %i(get post).include?(@method)
-          raise ArgumentError, 'method should be :get or :post'
-        end
-        @uri = uri
-        @body = body.to_s
-        @headers = headers.to_h
+      def attributes
+        {
+          method: method,
+          uri: uri,
+          body: body,
+          headers: headers,
+          credentials: credentials
+        }
       end
 
       def get?
@@ -37,6 +41,14 @@ module Poms
       def post?
         @method == :post
       end
+
+      private
+
+      def validate!
+        unless %i(get post).include?(@method)
+          raise ArgumentError, 'method should be :get or :post'
+        end
+      end
     end
   end
 end

data/lib/poms/api/search.rb

@@ -9,7 +9,9 @@ module Poms
         ends_at: 'end'
       }.freeze
 
-      def self.build(options)
+      module_function
+
+      def build(options)
         return {} if options.empty?
         all = options.map do |key, value|
           case key
@@ -22,9 +24,7 @@ module Poms
         all.reduce(&:deep_merge)
       end
 
-      private_class_method
-
-      def self.time_params(key, value)
+      def time_params(key, value)
         {
           'searches' => {
             'sortDates' => {
@@ -33,6 +33,8 @@ module Poms
           }
         }
       end
+
+      private_class_method :time_params
     end
   end
 end

data/lib/poms/fields.rb

@@ -46,11 +46,6 @@ module Poms
       item['mid']
     end
 
-    # Returns the revision from a Poms hash.
-    def rev(item)
-      item['_rev'].to_i
-    end
-
     # Returns an array of odi stream types.
     # Note: this code is copied from Broadcast and it is assumed it was working
     # there.
@@ -68,7 +63,7 @@ module Poms
     def available_until(item)
       return if item['predictions'].blank?
       internetvod = item['predictions']
-                    .find { |p| p['platform'] == 'INTERNETVOD' }
+        .find { |p| p['platform'] == 'INTERNETVOD' }
       return unless internetvod
       Timestamp.to_datetime(internetvod['publishStop'])
     end
@@ -103,6 +98,18 @@ module Poms
       Array(item['memberOf'])
     end
 
+    # Returns the NICAM age rating of the item or ALL if no age rating exists
+    def age_rating(item)
+      item.fetch('ageRating', 'ALL')
+    end
+
+    # Returns an array containing zero or more content ratings of the item
+    # Possible content ratings are:
+    # ANGST, DISCRIMINATIE, DRUGS_EN_ALCOHOL, GEWELD, GROF_TAALGEBRUIK and SEKS
+    def content_ratings(item)
+      item.fetch('contentRatings', [])
+    end
+
     # Returns an array of start and end times for the  scheduled events for
     # this item. It returns an empty array if no events are found. You can pass
     # in a block to filter the events on data that is not returned, like

data/lib/poms/version.rb

@@ -1,4 +1,4 @@
 # The version
 module Poms
-  VERSION = '2.1.3'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/poms.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
   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 'rubocop-rspec', '~> 1.7.0'
   spec.add_development_dependency 'rubocop', '~> 0.42.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poms
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Tom Kruijsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -217,14 +203,12 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
-- ".todo.reek"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/reek
 - bin/rspec
 - bin/rubocop
 - circle.yml

data/.todo.reek

@@ -1,52 +0,0 @@
----
-exclude_paths:
-  - vendor
-UncommunicativeVariableName:
-  exclude:
-  - Poms::Fields#available_until
-  - Poms::Fields#odi_streams
-  - Poms::MergedSeries#serie_mids
-  - Poms
-DuplicateMethodCall:
-  exclude:
-  - Poms::Api::Client#handle_response
-  - Poms::Api::RequestExecution#headers
-  - Poms::Builderless::Clip#position
-  - Poms::Builderless::Clip#video_url
-  - Poms::Field
-UtilityFunction:
-  exclude:
-  - Poms::Api::RequestExecution#execute_ssl_request
-  - Poms::Fields
-NilCheck:
-  exclude:
-  - Poms::Fields#odi_streams
-TooManyStatements:
-  exclude:
-  - Poms::Fields#odi_streams
-  - Poms::Api::Auth#sign
-  - Poms::Api::Drivers::NetHttp#attempt_request
-  - Poms::Api::PaginationClient#execute
-LongParameterList:
-  exclude:
-  - Poms::MergedSeries#serie_mids
-  - Poms::Api::Client#post
-  - Poms::Api::JsonClient#post
-FeatureEnvy:
-  exclude:
-  - Poms#first
-  - Poms::Api::Client#handle_response
-  - Poms::Api::Drivers::NetHttp#attempt_request
-  - Poms::Api::Drivers::NetHttp#execute
-  - Poms::Api::Drivers::NetHttp#prepare_request
-  - Poms::Api::Drivers::NetHttp#request_to_net_http_request
-  - Poms::Api::PaginationClient#execute
-NestedIterators:
-  exclude:
-  - Poms::Api::PaginationClient#execute
-Attribute:
-  exclude:
-  - Poms::Configuration#base_uri
-  - Poms::Configuration#key
-  - Poms::Configuration#secret
-  - Poms::Configuration#origin

data/bin/reek

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'reek' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("reek", "reek")