poms 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e3aa1829a203b60720b24083855ffb8a9f41621
+  data.tar.gz: 60ddc33138bde526bf72892201877abce90dbc29
+SHA512:
+  metadata.gz: 755e683ca19d2c23d29555426309d3618bfe2b0dcb30651341053c9332b8c61db00e0968dea06a1105ec9bf55b1c85ba71a867eeef1e7c7b29e3edf70480c3cb
+  data.tar.gz: 8f4e26864b024263e36f830cad01cd56a915c438d979c0ef3304b2d0217661f41d21f0fddb606029eec76ebf70e9b7aadfebb2549d699154d46a93393759bad7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in poms.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    poms (0.0.3)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    fabrication (2.11.3)
+    fakeweb (1.3.0)
+    ffi (1.9.3)
+    formatador (0.2.5)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    i18n (0.6.11)
+    json (1.8.1)
+    listen (2.7.9)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    minitest (5.4.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    timers (1.1.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  fabrication
+  fakeweb
+  guard
+  guard-rspec
+  poms!
+  rake
+  rspec

data/Guardfile

@@ -0,0 +1,12 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+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(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brightin BV
+
+MIT License
+
+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/README.md

@@ -0,0 +1,26 @@
+# Poms
+
+The Poms gem provides an interface to the Dutch public broadcaster API: POMS. It
+is a couchdb service that is publicly available.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'poms'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install poms
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/poms.rb

@@ -0,0 +1,110 @@
+require 'active_support'
+require 'open-uri'
+require 'json'
+require 'poms/base'
+require 'poms/version'
+require 'poms/builder'
+require 'poms/schedule_event'
+require 'poms/broadcast'
+require 'poms/season'
+require 'poms/series'
+
+module Poms
+  extend self
+  URL = 'http://docs.poms.omroep.nl'
+  MEDIA_PATH = '/media/'
+  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'
+  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?
+    hash = fetch_raw_json mid
+    Poms::Builder.process_hash hash
+  end
+
+  def fetch_raw_json(mid)
+    uri = [MEDIA_PATH, mid].join
+    get_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
+    hash = get_json(uri)
+    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']}
+  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']}
+  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']}
+  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
+    hash = get_json(uri)
+    hash['rows'].map {|item| Poms::Builder.process_hash item['doc']}
+  end
+
+  def fetch_current_broadcast(channel)
+    uri = [CHANNEL_AND_START_PATH, channel_params(channel, Time.now, 1.day.ago), '&descending=true&limit=1' ].join
+    hash = get_json(uri)
+    rows = hash['rows']
+    Poms::Builder.process_hash(rows.empty? ? {} : rows.first['doc'])
+  end
+
+  def fetch_next_broadcast(channel)
+    uri = [CHANNEL_AND_START_PATH, channel_params(channel, Time.now, 1.day.from_now), '&limit=1' ].join
+    hash = get_json(uri)
+    rows = hash['rows']
+    Poms::Builder.process_hash(rows.empty? ? {} : rows.first['doc'])
+  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"
+  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)
+    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"
+  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"
+  end
+
+  def get_json(uri)
+    begin
+      JSON.parse(open(URI.escape [URL, uri].join).read)
+    rescue OpenURI::HTTPError => e
+      raise e unless e.message.match(/404/)
+      nil
+    end
+  end
+
+end

data/lib/poms/base.rb

@@ -0,0 +1,7 @@
+module Poms
+  module Base
+    def rev
+      _rev.to_i
+    end
+  end
+end

data/lib/poms/broadcast.rb

@@ -0,0 +1,46 @@
+require 'poms/has_ancestors'
+require 'poms/has_base_attributes'
+
+module Poms
+  class Broadcast < Poms::Builder::NestedOpenStruct
+
+    include Poms::HasAncestors
+    include Poms::HasBaseAttributes
+
+    def initialize hash
+      super
+      process_schedule_events
+    end
+
+    def process_schedule_events
+      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
+    end
+
+    def series_mid
+      serie.try :mid_ref || serie.mid
+    end
+
+    def odi_streams
+      return [] if locations.nil? or 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]
+      end
+      streams.uniq
+    end
+
+    def available_until
+      return nil if locations.nil? or locations.empty?
+      timestamp = locations.map(&:publish_stop).compact.first
+      return Time.at(timestamp / 1000).to_datetime if timestamp
+    end
+
+  end
+
+  class Strand < Broadcast
+  end
+
+end

data/lib/poms/builder.rb

@@ -0,0 +1,78 @@
+require 'ostruct'
+require 'active_support/all'
+
+module Poms
+  class Builder
+    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
+      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)
+      end
+      klass.send(:new, underscored_hash)
+    end
+
+    private
+
+
+    class NestedOpenStruct < OpenStruct
+
+      include Poms::Base
+
+      def initialize(hash)
+        @hash = hash
+        @hash.each do |k,v|
+          process_key_value(k,v)
+        end
+        super hash
+      end
+
+      private
+
+      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)
+        when Hash
+          @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))
+          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"
+        end
+      end
+
+      def process_element(element)
+        case element
+        when String, Integer
+          element
+        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"
+        end
+      end
+    end
+  end
+
+
+  module Exceptions
+    class UnkownStructure < StandardError
+    end
+  end
+
+end

data/lib/poms/has_ancestors.rb

@@ -0,0 +1,42 @@
+module Poms
+  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?
+          descendant_of
+        else
+          descendant_series
+        end
+      end
+
+      def serie
+        series.first
+      end
+
+      def serie_mid
+        return nil if serie.nil?
+        serie.mid_ref || serie.mid
+      end
+
+      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
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end
+end