poms 0.0.10 → 1.0.0

data/lib/poms/connect.rb

@@ -1,13 +1,11 @@
 module Poms
+  # Module that gets json from a url.
   module Connect
-
     def get_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
   end
 end

data/lib/poms/has_ancestors.rb

@@ -1,16 +1,17 @@
 module Poms
+  # Mixin for a class that has ancestors.
   module HasAncestors
     module ClassMethods
-
     end
 
     module InstanceMethods
       def series
         return @series if @series
-        descendant_series = descendant_of.reject { |obj| obj.class != Poms::Series }
-        if descendant_of.blank?
-          []
-        elsif descendant_series.blank?
+        return [] if descendant_of.blank?
+        descendant_series = descendant_of.reject do |obj|
+          obj.class != Poms::Series
+        end
+        if descendant_series.blank?
           descendant_of
         else
           descendant_series
@@ -28,9 +29,20 @@ module Poms
 
       def ancestor_mids
         return @ancestor_mids if @ancestor_mids
-        descendant_of_mids = descendant_of.map(&:mid_ref) rescue []
-        episode_of_mids = episode_of.map(&:mid_ref) rescue  []
-        @ancestor_mids = (descendant_of_mids + episode_of_mids).flatten.compact.uniq
+        @ancestor_mids = (descendant_of_mids +
+          episode_of_mids).flatten.compact.uniq
+      end
+
+      def descendant_of_mids
+        descendant_of.map(&:mid_ref)
+      rescue
+        []
+      end
+
+      def episode_of_mids
+        episode_of.map(&:mid_ref)
+      rescue
+        []
       end
     end
 

data/lib/poms/has_base_attributes.rb

@@ -1,14 +1,23 @@
 module Poms
+  # Mixin for classes with a title and description.
   module HasBaseAttributes
     def title
       return @title if @title
       main_title = select_title_by_type 'MAIN'
       sub_title = select_title_by_type 'SUB'
-      @titel = (sub_title && sub_title.match(main_title)) ? sub_title : [main_title, sub_title].compact.join(": ")
+      if sub_title && sub_title.match(main_title)
+        @titel = sub_title
+      else
+        @titel = [main_title, sub_title].compact.join(': ')
+      end
     end
 
     def description
-      @description ||= descriptions.first.value rescue nil
+      @description ||= begin
+                         descriptions.first.value
+                       rescue
+                         nil
+                       end
     end
 
     private

data/lib/poms/merged_series.rb

@@ -0,0 +1,27 @@
+require 'open-uri'
+require 'timeout'
+
+module Poms
+  # Methods for working with the merged series api from NPO.
+  module MergedSeries
+    extend self
+
+    API_URL = 'https://rs-test.poms.omroep.nl/v1/api/media/redirects/'.freeze
+
+    # Gets the merged serie mids as a hash. Expects a JSON response from
+    # the server with a `map` key.
+    # Throws a PomsError if the call timeouts, has an HTTP error or JSON parse
+    # error.
+    #
+    # @param api_url the API url to query
+    # @return [Hash] a hash with old_mid => new_mid pairs
+    def serie_mids(api_url = API_URL)
+      Timeout.timeout(3) do
+        data = open(api_url).read
+        JSON.parse(data).fetch('map')
+      end
+    rescue OpenURI::HTTPError, JSON::ParserError, Timeout::Error => e
+      raise Poms::PomsError, e.message
+    end
+  end
+end

data/lib/poms/poms_error.rb

@@ -0,0 +1,5 @@
+module Poms
+  # A generic error for things that go wrong inside Poms.
+  class PomsError < StandardError
+  end
+end

data/lib/poms/schedule_event.rb

@@ -1,7 +1,7 @@
 module Poms
+  # POMS wrapper for a single scheduled broadcast.
   class ScheduleEvent < Poms::Builder::NestedOpenStruct
-
-    def initialize hash
+    def initialize(hash)
       @hash = hash
       set_start_and_end_times
       super @hash
@@ -16,11 +16,11 @@ module Poms
 
     def set_starts_at
       @hash[:starts_at] = case @hash[:start]
-        when String, Integer
-          Time.at @hash[:start] / 1000
-        when Time
-          @hash[:start]
-        end
+                          when String, Integer
+                            Time.at @hash[:start] / 1000
+                          when Time
+                            @hash[:start]
+                          end
     end
 
     def set_ends_at
@@ -30,7 +30,5 @@ module Poms
     def duration
       (@hash[:duration].to_i / 1000).seconds
     end
-
   end
 end
-

data/lib/poms/season.rb

@@ -1,13 +1,13 @@
 require 'poms/has_ancestors'
 
 module Poms
+  # Poms wrapper for a season of a serie.
   class Season < Poms::Builder::NestedOpenStruct
     include Poms::HasBaseAttributes
     include Poms::HasAncestors
 
     def related_group_mids
-      descendant_of.map &:mid_ref
+      descendant_of.map(&:mid_ref)
     end
   end
 end
-  

data/lib/poms/series.rb

@@ -1,12 +1,12 @@
 require 'poms/has_base_attributes'
 
 module Poms
+  # POMS wrapper for a TV Serie.
   class Series < Poms::Builder::NestedOpenStruct
     include Poms::HasBaseAttributes
-    
+
     def related_group_mids
-      Poms.fetch_descendants_for_serie(mid, 'SEASON').map &:mid
-    end   
+      Poms.fetch_descendants_for_serie(mid, 'SEASON').map(&:mid)
+    end
   end
 end
-  

data/lib/poms/version.rb

@@ -1,3 +1,4 @@
+# The version
 module Poms
-  VERSION = '0.0.10'
+  VERSION = '1.0.0'
 end

data/lib/poms/views.rb

@@ -1,7 +1,7 @@
 require 'poms/connect'
 
-# Constructs urls for Poms
 module Poms
+  # Views constructs the urls that can be used to access specific views in POMS.
   module Views
     include Poms::Connect
     extend self
@@ -20,7 +20,10 @@ module Poms
       construct_view_url('by-group', args)
     end
 
-    def broadcasts_by_channel_and_start(channel, start_time = Time.now, end_time = 1.day.ago, limit = 1, descending = true)
+    # rubocop:disable Metrics/MethodLength
+    def broadcasts_by_channel_and_start(channel, start_time = Time.now,
+                                        end_time = 1.day.ago, limit = 1,
+                                        descending = true)
       args = {
         startkey: "[\"#{channel}\", #{to_poms_timestamp(start_time)}]",
         endkey: "[\"#{channel}\", #{to_poms_timestamp(end_time)}]",
@@ -31,6 +34,7 @@ module Poms
       }
       construct_view_url('broadcasts-by-channel-and-start', args)
     end
+    # rubocop:enable Metrics/MethodLength
 
     private
 

data/poms.gemspec

@@ -5,28 +5,29 @@ require 'poms/version'
 require 'rake'
 
 Gem::Specification.new do |spec|
-  spec.name          = "poms"
+  spec.name          = 'poms'
   spec.version       = Poms::VERSION
-  spec.authors       = ["Tom Kruijsen", "Stijn Meurkens", "Tijn Schuurmans"]
-  spec.email         = ["tom@brightin.nl", "stijn@brightin.nl", "tijn@brightin.nl"]
-  spec.description   = %q{Interface to POMS CouchDB API}
-  spec.summary       = %q{Interfcae to POMS CouchDB API}
-  spec.homepage      = "https://github.com/brightin/poms"
-  spec.license       = "MIT"
+  spec.authors       = ['Tom Kruijsen', 'Stijn Meurkens', 'Tijn Schuurmans']
+  spec.email         = ['tom@brightin.nl', 'stijn@brightin.nl',
+                        'tijn@brightin.nl']
+  spec.description   = 'Interface to POMS CouchDB API'
+  spec.summary       = 'Interfcae to POMS CouchDB API'
+  spec.homepage      = 'https://github.com/brightin/poms'
+  spec.license       = 'MIT'
 
-  spec.files         = FileList['lib/**/*.rb',  '[A-Z]*', 'spec/**/*'].to_a
+  spec.files         = FileList['lib/**/*.rb', '[A-Z]*', 'spec/**/*'].to_a
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "fakeweb"
-  spec.add_development_dependency "fabrication"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "timecop"
-  spec.add_development_dependency "vcr"
-  spec.add_dependency "activesupport"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'fakeweb'
+  spec.add_development_dependency 'fabrication'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'vcr'
+  spec.add_dependency 'activesupport'
 end

data/spec/fabricators/poms_fabricator.rb

@@ -14,10 +14,13 @@ Fabricator(:poms_broadcast_pippi_langkous, class_name: :"Poms::Broadcast") do
   end
 end
 
-Fabricator(:poms_broadcast_multiple_schedule_events, class_name: :"Poms::Broadcast") do
+Fabricator(:poms_broadcast_multiple_schedule_events,
+           class_name: :"Poms::Broadcast") do
   initialize_with do
     Poms::Builder.process_hash(
-      JSON.parse File.read('spec/fixtures/poms_broadcast_multiple_schedule_events.json')
+      JSON.parse(
+        File.read('spec/fixtures/poms_broadcast_multiple_schedule_events.json')
+      )
     )
   end
 end
@@ -33,7 +36,9 @@ end
 Fabricator(:zapp_broadcasts, class_name: :array) do
   initialize_with do
     hash = JSON.parse File.read('spec/fixtures/poms_zapp.json')
-    array = hash['rows'].take(10).map {|item| Poms::Builder.process_hash item['doc']}
+    array = hash['rows'].take(10).map do |item|
+      Poms::Builder.process_hash item['doc']
+    end
     array
   end
 end

data/spec/fixtures/vcr_cassettes/poms/merged_series/is_enumerable.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://rs-test.poms.omroep.nl/v1/api/media/redirects/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Tue, 05 Jan 2016 16:49:33 GMT
+      server:
+      - Apache/2.4.12 (Unix) OpenSSL/1.0.1k
+      vary:
+      - Accept
+      cache-control:
+      - public
+      etag:
+      - '"47646207"'
+      last-modified:
+      - Tue, 05 Jan 2016 08:47:10 GMT
+      content-type:
+      - application/json;charset=utf-8
+      x-proxyinstancename:
+      - poms1a
+      set-cookie:
+      - balancer://poms8cluster=balancer.poms8aas; path=/;
+      transfer-encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"lastUpdate":"2016-01-05T09:47:10.672+01:00","map":{"POMS_S_EO_097367":"VPWON_1257896"}}'
+    http_version: '1.1'
+  recorded_at: Tue, 06 Oct 2015 12:00:00 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/poms/merged_series/turns_the_json_into_a_hash.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://rs-test.poms.omroep.nl/v1/api/media/redirects/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Tue, 05 Jan 2016 16:34:17 GMT
+      server:
+      - Apache/2.4.12 (Unix) OpenSSL/1.0.1k
+      vary:
+      - Accept
+      cache-control:
+      - public
+      etag:
+      - '"47646207"'
+      last-modified:
+      - Tue, 05 Jan 2016 08:47:10 GMT
+      content-type:
+      - application/json;charset=utf-8
+      x-proxyinstancename:
+      - poms1a
+      set-cookie:
+      - balancer://poms8cluster=balancer.poms8aas; path=/;
+      transfer-encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"lastUpdate":"2016-01-05T09:47:10.672+01:00","map":{"POMS_S_EO_097367":"VPWON_1257896"}}'
+    http_version: '1.1'
+  recorded_at: Tue, 06 Oct 2015 12:00:00 GMT
+recorded_with: VCR 2.9.3

data/spec/integration/poms_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Poms do
-
   describe '#fetch_current_broadcast' do
     let(:current_broadcast) { Poms.fetch_current_broadcast('NED3') }
 
@@ -71,5 +70,5 @@ describe Poms do
   end
 
   describe '#upcoming_broadcasts'
-  describe '#fetch_descendant_mids'  
+  describe '#fetch_descendant_mids'
 end

data/spec/lib/poms/broadcast_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Poms::Broadcast do
-
   let(:poms_broadcast) { Fabricate(:poms_broadcast) }
   # pippi langkous is a peculiar case, as it has no series, just a season
   let(:poms_pippi_langkous) { Fabricate(:poms_broadcast_pippi_langkous) }
@@ -15,18 +14,22 @@ describe Poms::Broadcast do
   end
 
   it 'correctly sets the description' do
-    description = "Li biedt Barry een baantje aan bij de uitdragerij en vraagt zich meteen af of dat wel zo slim was. Timon en Joep zien de criminele organisatie de Rijland Angels. Timon wil naar hun loods, maar is dat wel een goed idee?"
+    description = 'Li biedt Barry een baantje aan bij de uitdragerij en ' \
+    'vraagt zich meteen af of dat wel zo slim was. Timon en Joep zien de ' \
+    'criminele organisatie de Rijland Angels. Timon wil naar hun loods, maar ' \
+    'is dat wel een goed idee?'
     expect(poms_broadcast.description).to eq(description)
   end
 
-  it 'converts schedule events to Poms::ScheduleEvent'  do
+  it 'converts schedule events to Poms::ScheduleEvent' do
     poms_broadcast.schedule_events.each do |e|
       expect(e.class).to eq(Poms::ScheduleEvent)
     end
   end
 
   it 'correctly sets available until' do
-    expect(poms_broadcast.available_until).to eq(Time.at(1435381968).to_datetime)
+    expect(poms_broadcast.available_until)
+      .to eq(Time.at(1_435_381_968).to_datetime)
   end
 
   it 'sets the serie correctly when a broadcast only has a season, no series' do
@@ -34,11 +37,13 @@ describe Poms::Broadcast do
   end
 
   it 'returns the available streams' do
-    expect(poms_broadcast.odi_streams).to eq(["adaptive", "h264_sb", "h264_bb", "h264_std", "wvc1_std", "wmv_sb", "wmv_bb"])
+    expect(poms_broadcast.odi_streams)
+      .to eq(%w(adaptive h264_sb h264_bb h264_std wvc1_std wmv_sb wmv_bb))
   end
 
   it 'return the ancestors of the broadcast' do
     # I use to_set as the order does not matter
-    expect(poms_broadcast.ancestor_mids.to_set).to eq(['POMS_S_KRO_059857', 'KRO_1521173'].to_set)
+    expect(poms_broadcast.ancestor_mids.to_set)
+      .to eq(%w(POMS_S_KRO_059857 KRO_1521173).to_set)
   end
 end