poms 0.0.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d88b5950a24b290c42a49e6ca6a94954acbd34c
-  data.tar.gz: 12f31608e9c7511c5bfbf8e454986d605a50d93d
+  metadata.gz: 4333611e09f4d9d9e64bc14b1df3bbce76593022
+  data.tar.gz: 95ca2bb08c7d0ea5268b19d043e3d09079f251c9
 SHA512:
-  metadata.gz: 1a829adaf9187590258ea1f8c4ab25f87caa3823fbcc112e7b9764b8680746a3c76e2ee29eb20435aa342559a39a9ab4e8e841495c2cda12cd697f68e5863ccf
-  data.tar.gz: ec1957d987c22eca71960f423ce0d23d440766ebab9207fa6c03263383466df78fb61ff8577816c717fd6c062eaeade84cd4be8a18e19585ea0ef57654ca9885
+  metadata.gz: 0a3ad89078d35c87c4859a495558598a16ed81b8d3f178d4f0548f20db8d86cb957c746e9d23f5464dd3b1f643d8611b19e4c511531210649de0462151f7e8bd
+  data.tar.gz: 5d1b7e1e13d6dc8d0aeb1d411fa540049cc4958887f3683a153c6b05dab3f60b1b2698d8af6eb2982c3aa418deedeaf9fff805f5cd2a1e1510e3488dd5e88cf0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    poms (0.0.10)
+    poms (1.0.0)
       activesupport
 
 GEM
@@ -60,7 +60,7 @@ GEM
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rainbow (2.0.0)
-    rake (10.4.2)
+    rake (10.1.0)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)

data/Guardfile

@@ -4,9 +4,9 @@
 guard :rspec do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { 'spec' }
+  watch('config/routes.rb')                           { 'spec/routing' }
+  watch('app/controllers/application_controller.rb')  { 'spec/controllers' }
 end

data/Rakefile

@@ -1,12 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec
 
-desc "Open an irb session preloaded with this library"
+desc 'Open an irb session preloaded with this library'
 task :console do
-  sh "irb -rubygems -I lib -r poms.rb"
+  sh 'irb -rubygems -I lib -r poms.rb'
 end

data/lib/poms.rb

@@ -12,21 +12,26 @@ require 'poms/views'
 require 'poms/fields'
 require 'poms/builderless/broadcast'
 require 'poms/builderless/clip'
+require 'poms/merged_series'
+require 'poms/poms_error'
 
+# Module that allows interfacing with the POMS CouchDB service.
+# rubocop:disable Metrics/ModuleLength
 module Poms
   extend Poms::Views
   extend Poms::Fields
   extend self
 
-
   URL = 'http://docs.poms.omroep.nl'
   MEDIA_PATH = '/media/'
-  BROADCASTS_VIEW_PATH = '/media/_design/media/_view/broadcasts-by-broadcaster-and-start'
+  BROADCASTS_VIEW_PATH =
+    '/media/_design/media/_view/broadcasts-by-broadcaster-and-start'
   ANCESTOR_AND_TYPE_PATH = '/media/_design/media/_view/by-ancestor-and-type'
-  ANCESTOR_AND_SORTDATE_PATH = '/media/_design/media/_view/by-ancestor-and-sortdate'
-  CHANNEL_AND_START_PATH = '/media/_design/media/_view/broadcasts-by-channel-and-start'
+  ANCESTOR_AND_SORTDATE_PATH =
+    '/media/_design/media/_view/by-ancestor-and-sortdate'
+  CHANNEL_AND_START_PATH =
+    '/media/_design/media/_view/broadcasts-by-channel-and-start'
   VALID_CHANNELS = /^NED(1|2|3)$/
-  #  ?startkey=[\"Zapp\",1369755130000]&endkey=[\"Zapp\",1370964770000]&reduce=false&include_docs=true
 
   def fetch(mid)
     return nil if mid.nil?
@@ -42,7 +47,9 @@ module Poms
   def fetch_playlist_clips(mid)
     uri = Poms::Views.by_group(mid)
     playlist_hash = get_bare_json(uri)
-    playlist_hash['rows'].map { |hash| Poms::Builderless::Clip.new(hash['doc']) }
+    playlist_hash['rows'].map do |hash|
+      Poms::Builderless::Clip.new(hash['doc'])
+    end
   end
 
   def fetch_raw_json(mid)
@@ -55,36 +62,42 @@ module Poms
     get_bare_json(uri)
   end
 
-  def upcoming_broadcasts(zender, start_time = Time.now, end_time = Time.now+7.days)
-    uri = [BROADCASTS_VIEW_PATH, broadcast_view_params(zender, start_time, end_time )].join
+  def upcoming_broadcasts(zender, start_time = Time.now,
+                          end_time = Time.now + 7.days)
+    view_params = broadcast_view_params(zender, start_time, end_time)
+    uri = [BROADCASTS_VIEW_PATH, view_params].join
     hash = get_json(uri)
-    hash['rows'].map {|item| Poms::Builder.process_hash item['doc']}
+    hash['rows'].map { |item| Poms::Builder.process_hash item['doc'] }
   end
 
-  def fetch_descendants_for_serie(mid, type='BROADCAST')
-    uri = [ANCESTOR_AND_TYPE_PATH, ancestor_type_params(mid, type) ].join
-    hash = get_json(uri) || {'rows' => []}
-    hash['rows'].map {|item| Poms::Builder.process_hash item['doc']}
+  def fetch_descendants_for_serie(mid, type = 'BROADCAST')
+    uri = [ANCESTOR_AND_TYPE_PATH, ancestor_type_params(mid, type)].join
+    hash = get_json(uri) || { 'rows' => [] }
+    hash['rows'].map { |item| Poms::Builder.process_hash item['doc'] }
   end
 
   alias_method :fetch_broadcasts_for_serie, :fetch_descendants_for_serie
 
-  def fetch_descendants_by_date_for_serie(mid, start_time=1.week.ago)
-    uri = [ANCESTOR_AND_SORTDATE_PATH, ancestor_sortdate_params(mid, start_time) ].join
-    hash = get_json(uri) || {'rows' => []}
-    hash['rows'].map {|item| Poms::Builder.process_hash item['doc']}
+  def fetch_descendants_by_date_for_serie(mid, start_time = 1.week.ago)
+    view_params = ancestor_sortdate_params(mid, start_time)
+    uri = [ANCESTOR_AND_SORTDATE_PATH, view_params].join
+    hash = get_json(uri) || { 'rows' => [] }
+    hash['rows'].map { |item| Poms::Builder.process_hash item['doc'] }
   end
 
-  def fetch_descendant_mids(mid, type='BROADCAST')
-    uri = [ANCESTOR_AND_TYPE_PATH, ancestor_type_params(mid, type), "&include_docs=false"].join
-    hash = get_json(uri) || {'rows' => []}
-    hash['rows'].map {|item| item['id']}
+  def fetch_descendant_mids(mid, type = 'BROADCAST')
+    view_params = ancestor_type_params(mid, type)
+    uri = [ANCESTOR_AND_TYPE_PATH, view_params, '&include_docs=false'].join
+    hash = get_json(uri) || { 'rows' => [] }
+    hash['rows'].map { |item| item['id'] }
   end
 
-  def fetch_broadcasts_by_channel_and_start(channel, start_time=1.week.ago, end_time=Time.now)
-    uri = [CHANNEL_AND_START_PATH, channel_params(channel, start_time, end_time) ].join
+  def fetch_broadcasts_by_channel_and_start(channel, start_time = 1.week.ago,
+                                            end_time = Time.now)
+    view_params = channel_params(channel, start_time, end_time)
+    uri = [CHANNEL_AND_START_PATH, view_params].join
     hash = get_json(uri)
-    hash['rows'].map {|item| Poms::Builder.process_hash item['doc']}
+    hash['rows'].map { |item| Poms::Builder.process_hash item['doc'] }
   end
 
   def fetch_current_broadcast(channel)
@@ -95,39 +108,48 @@ module Poms
   end
 
   def fetch_current_broadcast_and_key(channel)
-    hash = get_json(channel_and_start_uri(channel, Time.now, 1.day.ago, {limit: 1, descending: true}))
-    {key: get_first_key(hash), broadcast: get_first_broadcast(hash)}
+    hash = get_json(channel_and_start_uri(
+                      channel, Time.now, 1.day.ago, limit: 1, descending: true)
+                   )
+    { key: get_first_key(hash), broadcast: get_first_broadcast(hash) }
   end
 
   def fetch_next_broadcast(channel)
-    hash = get_json(channel_and_start_uri(channel, Time.now, 1.day.from_now, {limit: 1}))
+    hash = get_json(channel_and_start_uri(
+                      channel, Time.now, 1.day.from_now, limit: 1)
+                   )
     get_first_broadcast(hash)
   end
 
   def fetch_next_broadcast_and_key(channel)
-    hash = get_json(channel_and_start_uri(channel, Time.now, 1.day.from_now, {limit: 1}))
-    {key: get_first_key(hash), broadcast: get_first_broadcast(hash)}
+    hash = get_json(channel_and_start_uri(
+                      channel, Time.now, 1.day.from_now, limit: 1)
+                   )
+    { key: get_first_key(hash), broadcast: get_first_broadcast(hash) }
   end
 
-  # private
   def broadcast_view_params(zender, start_time, end_time)
     zender = zender.capitalize
-    "?startkey=[\"#{zender}\",#{start_time.to_i * 1000}]&endkey=[\"#{zender}\",#{end_time.to_i * 1000}]&reduce=false&include_docs=true"
+    "?startkey=[\"#{zender}\",#{start_time.to_i * 1000}]" \
+    "&endkey=[\"#{zender}\",#{end_time.to_i * 1000}]" \
+    '&reduce=false&include_docs=true'
   end
 
   def ancestor_type_params(mid, type)
     "?reduce=false&key=[\"#{mid}\",\"#{type}\"]&include_docs=true"
   end
 
-  def ancestor_sortdate_params(mid, start_time=1.month.ago)
+  def ancestor_sortdate_params(mid, start_time = 1.month.ago)
     end_time_i    = 1.week.from_now.to_i * 1000
     start_time_i  = start_time.to_i * 1000
-    "?reduce=false&startkey=[\"#{mid}\",#{start_time_i}]&endkey=[\"#{mid}\",#{end_time_i}]&include_docs=true"
+    "?reduce=false&startkey=[\"#{mid}\",#{start_time_i}]" \
+    "&endkey=[\"#{mid}\",#{end_time_i}]&include_docs=true"
   end
 
-
   def channel_params(channel, start_time, end_time)
-    "?startkey=[\"#{channel}\",#{start_time.to_i * 1000}]&endkey=[\"#{channel}\",#{end_time.to_i * 1000}]&reduce=false&include_docs=true"
+    "?startkey=[\"#{channel}\",#{start_time.to_i * 1000}]" \
+    "&endkey=[\"#{channel}\",#{end_time.to_i * 1000}]" \
+    '&reduce=false&include_docs=true'
   end
 
   def get_json(uri)
@@ -137,17 +159,16 @@ module Poms
   private
 
   def get_bare_json(uri)
-    begin
-      JSON.parse(open(uri).read)
-    rescue OpenURI::HTTPError => e
-      raise e unless e.message.match(/404/)
-      nil
-    end
+    JSON.parse(open(uri).read)
+  rescue OpenURI::HTTPError => e
+    raise e unless e.message.match(/404/)
+    nil
   end
 
-  def channel_and_start_uri(channel, start_time, end_time, options={})
+  def channel_and_start_uri(channel, start_time, end_time, options = {})
     query_options = options.blank? ? '' : "&#{options.to_query}"
-    [CHANNEL_AND_START_PATH, channel_params(channel, start_time, end_time), query_options ].join
+    view_params = channel_params(channel, start_time, end_time)
+    [CHANNEL_AND_START_PATH, view_params, query_options].join
   end
 
   def get_first_broadcast(hash)
@@ -159,5 +180,5 @@ module Poms
     rows = hash['rows']
     rows.empty? ? [] : rows.first['key']
   end
-
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/poms/base.rb

@@ -1,4 +1,5 @@
 module Poms
+  # Mixin for base POMS functionality.
   module Base
     def rev
       _rev.to_i

data/lib/poms/broadcast.rb

@@ -2,12 +2,12 @@ require 'poms/has_ancestors'
 require 'poms/has_base_attributes'
 
 module Poms
+  # POMS wrapper for an episode of a Serie.
   class Broadcast < Poms::Builder::NestedOpenStruct
-
     include Poms::HasAncestors
     include Poms::HasBaseAttributes
 
-    def initialize hash
+    def initialize(hash)
       super
       process_schedule_events
     end
@@ -16,7 +16,9 @@ module Poms
       if schedule_events
         schedule_events.select! { |e| e.channel.match Poms::VALID_CHANNELS }
       end
-      self.schedule_events = schedule_events.map { |e| Poms::ScheduleEvent.new e.marshal_dump } if schedule_events
+      self.schedule_events = schedule_events.map do |e|
+        Poms::ScheduleEvent.new e.marshal_dump
+      end if schedule_events
     end
 
     def series_mid
@@ -24,10 +26,10 @@ module Poms
     end
 
     def odi_streams
-      return [] if locations.nil? or locations.empty?
+      return [] if locations.nil? || locations.empty?
       odi_streams = locations.select { |l| l.program_url.match(/^odi/) }
       streams = odi_streams.map do |l|
-        l.program_url.match(/^[\w+]+\:\/\/[\w\.]+\/video\/(\w+)\/\w+/)[1]
+        l.program_url.match(%r{^[\w+]+\:\/\/[\w\.]+\/video\/(\w+)\/\w+})[1]
       end
       streams.uniq
     end
@@ -50,5 +52,4 @@ module Poms
 
   class Strand < Broadcast
   end
-
 end

data/lib/poms/builder.rb

@@ -2,65 +2,72 @@ require 'ostruct'
 require 'active_support/all'
 
 module Poms
+  # Builds the correct object based on the result from POMS.
   class Builder
     SUPPORTED_CLASSES = %w(Broadcast Season Series Views Typeless)
 
     def self.process_hash(hash)
       return unless hash
-      underscored_hash = {}
-      hash.each { |k,v| underscored_hash[k.underscore] = v }
-      class_name = (underscored_hash['type'] || "Typeless").capitalize
-      class_name = pomsify_class_name(class_name)
-      begin
-        klass = Poms.const_get class_name
-      rescue NameError
-        # c = Class.new(Poms::NestedOpenStruct)
-        klass = Poms.const_set class_name, Class.new(Poms::Builder::NestedOpenStruct)
+      underscored_hash = hash.each_with_object({}) do |(k, v), res|
+        res[k.underscore] = v
       end
+      class_name = pomsify_class_name(underscored_hash['type'])
+      klass = poms_class(class_name)
       klass.send(:new, underscored_hash)
     end
 
-    private
-
     def self.pomsify_class_name(class_name)
-      class_name = "Poms" + class_name unless SUPPORTED_CLASSES.include? class_name
+      class_name = class_name.blank? ? 'Typeless' : class_name.capitalize
+      class_name =
+        'Poms' + class_name unless SUPPORTED_CLASSES.include? class_name
       class_name
     end
 
-    class NestedOpenStruct < OpenStruct
+    def self.poms_class(class_name)
+      Poms.const_get class_name
+    rescue NameError
+      Poms.const_set class_name, Class.new(Poms::Builder::NestedOpenStruct)
+    end
 
+    # An OpenStruct subclass that allows nesting to simulate a hash.
+    class NestedOpenStruct < OpenStruct
       include Poms::Base
 
       def initialize(hash)
         @hash = hash
-        @hash.each do |k,v|
-          process_key_value(k,v)
+        @hash.each do |k, v|
+          process_key_value(k, v)
         end
         super hash
       end
 
-      private
-
+      # rubocop:disable Metrics/MethodLength
       def process_key_value(k, v)
         case v
         when Array
-          struct_array = v.map do |element|
-            process_element(element)
-          end
-          @hash.send("[]=", k, struct_array)
+          process_array(k, v)
         when Hash
-          @hash.send("[]=", k, Poms::Builder.process_hash(v))
+          @hash.send('[]=', k, Poms::Builder.process_hash(v))
         when String, Integer
-
           case k
-          when "start", "end", "sort_date"
-            @hash.send("[]=", k, Time.at(v / 1000))
+          when 'start', 'end', 'sort_date'
+            @hash.send('[]=', k, Time.at(v / 1000))
           end
         when NilClass, FalseClass, TrueClass, Time, Poms::Typeless
           # do nothing
         else
-          raise Poms::Exceptions::UnkownStructure, "Error processing #{v.class}: #{v}, which was expected to be a String or Array"
+          fail Poms::Exceptions::UnkownStructure,
+               "Error processing #{v.class}: #{v}, which was expected to be " \
+               'a String or Array'
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def process_array(key, value)
+        struct_array = value.map do |element|
+          process_element(element)
         end
+        @hash.send('[]=', key, struct_array)
       end
 
       def process_element(element)
@@ -70,16 +77,16 @@ module Poms
         when Hash
           Poms::Builder.process_hash element
         else
-          raise Poms::Exceptions::UnkownStructure, "Error processing #{element}: which was expected to be a String nor a Hash"
+          fail Poms::Exceptions::UnkownStructure,
+               "Error processing #{element}: which was expected to be a " \
+               'String nor a Hash'
         end
       end
     end
   end
 
-
   module Exceptions
     class UnkownStructure < StandardError
     end
   end
-
 end

data/lib/poms/builderless/broadcast.rb

@@ -2,7 +2,7 @@ require 'poms/fields'
 
 module Poms
   module Builderless
-    # A single broadcast fetched from Poms
+    # A single broadcast (episode) fetched from Poms
     class Broadcast
       def initialize(hash)
         @hash = hash
@@ -23,6 +23,7 @@ module Poms
       end
     end
 
+    # A single event of a broadcast.
     class Event
       def initialize(hash)
         @hash = hash

data/lib/poms/builderless/clip.rb

@@ -2,7 +2,7 @@ require 'poms/fields'
 
 module Poms
   module Builderless
-    # A single broadcast fetched from Poms
+    # A single clip fetched from Poms
     class Clip
       def initialize(hash)
         @hash = hash