poms 2.3.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 85292060b0c5dea4b9f7398aeb16a9d0f6df5190
-  data.tar.gz: ee21d0dd068514a0ee38d93a2719f9969fb48a28
+SHA256:
+  metadata.gz: 46e3a79979a57e2affbc2189de4b437d60df153480000317be82b5e3c54eddb6
+  data.tar.gz: bc638af72e54f6a78d9aaa3facc97e33a8e9fbce7a32a6f7ae45dbb45468fc81
 SHA512:
-  metadata.gz: 7b7b665ceb080c2f88785c76da9c833232180f2e25f789234f8d37928e636cdee8763229a6ea76fc1d86d10e1edf5407ef6c1da30799d053b5c96bc6a942b175
-  data.tar.gz: 792cf6b0628b82dbced00ef5b6990219d99fb83a9b45ee15274ae4bc8d24dd410d29fc95cdeec17e0d31ce0c6c2b4963da967280f8d69cbaca747a74fc4e13e8
+  metadata.gz: 6444a71292577a4fdf53d1d91e65b01f22c5ebf0a8f39859382e81ecc75933d8a1877099e55e6ad3c2a8abb09bb4f3a707fecab199aab4bfe09a7e57b30b3cad
+  data.tar.gz: 1f2c35dfc336b503fa396e81e1a0847bdc240dc0a95e0cc234d541e16e3ee9a52d81fe6bbd8faa80cb618b14475d6b4ba9d8f3785fffcad33d275a385beaeebf

data/.circleci/config.yml

@@ -0,0 +1,15 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.3.4-node-browsers
+        environment:
+          POMS_KEY: key
+          POMS_ORIGIN: origin
+          POMS_SECRET: secret
+          TZ: "/usr/share/zoneinfo/Europe/Amsterdam"
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rubocop
+      - run: bundle exec rspec

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .ruby-version
+.rbenv-vars

data/.rubocop.yml

@@ -30,6 +30,9 @@ Style/AndOr:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/ModuleFunction:
+  Enabled: false
+
 ModuleLength:
   Exclude:
     - spec/**/*_spec.rb # specs are only in module for easier access to functions

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Poms Release notes
 
+## 2.6.0
+
+* Include `Poms::Fields` in the main library file.
+
+## 2.5.1
+
+* Actually filter out publications with `owner` `NEBO`.
+
+## 2.5.0
+
+* ~Filter out publications with `owner` `NEBO`.~
+
+Due to an error this version does not include the mentioned change.
+
+## 2.4.0
+
+* Add functions for getting `publish_start` and `publish_stop` from Poms in `Poms::Fields`.
+
+## 2.3.1
+
+* Add `Poms::Fields.descendants_of` which returns all descendantOf's of specific type.
+
+## 2.3.0
+
+* Make `members` run as a POST request.
+
 ## 2.2.1
 
 * Add `Poms::Fields.broadcasts` which returns the associated broadcasters in an Array

data/README.md

@@ -84,3 +84,7 @@ Gem | API
 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
+
+## Releasing
+
+Make sure to use [Semantic Versioning](https://semver.org/) when bumping the version. To release tag the master branch with the version and then push to rubygems. `rake release` does this for you.

data/lib/poms.rb

@@ -6,6 +6,7 @@ require 'poms/api/request'
 require 'poms/errors'
 require 'poms/api/search'
 require 'poms/configuration'
+require 'poms/fields'
 require 'json'
 
 # Main interface for the POMS gem

data/lib/poms/fields.rb

@@ -1,160 +1,13 @@
-require 'poms/timestamp'
+require 'poms/fields/details'
+require 'poms/fields/media'
+require 'poms/fields/schedule'
 
 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.
+  # Collection module that import the various field modules to the higher
+  # Poms::Fields level
   module Fields
-    module_function
-
-    IMAGE_TYPE_PRIORITY = %w[PROMO_LANDSCAPE PICTURE].freeze
-
-    # Returns the title, main by default
-    def title(item, type = 'MAIN')
-      value_of_type(item, 'titles', type)
-    end
-
-    # Returns the description, main by default
-    def description(item, type = 'MAIN')
-      value_of_type(item, 'descriptions', type)
-    end
-
-    def broadcasters(item)
-      Array(item['broadcasters']).map do |key_value_pair|
-        key_value_pair['value']
-      end
-    end
-
-    # Returns the images from the hash
-    def images(item)
-      item['images'].try(:sort_by) do |i|
-        image_order_index(i)
-      end
-    end
-
-    # 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
-
-    def image_order_index(image)
-      IMAGE_TYPE_PRIORITY.index(image['type']) || IMAGE_TYPE_PRIORITY.size
-    end
-
-    # Returns the id of the first image or nil if there are none.
-    def first_image_id(item)
-      return unless images(item)
-      image_id(images(item).first)
-    end
-
-    def mid(item)
-      item['mid']
-    end
-
-    # Returns an array of odi stream types.
-    # Note: this code is copied from Broadcast and it is assumed it was working
-    # there.
-    def odi_streams(item)
-      locations = item['locations']
-      return [] if locations.nil? || locations.empty?
-      odi_streams = locations.select { |l| l['programUrl'].match(/^odi/) }
-      streams = odi_streams.map do |l|
-        l['programUrl'].match(%r{^[\w+]+\:\/\/[\w\.]+\/video\/(\w+)\/\w+})[1]
-      end
-      streams.uniq
-    end
-
-    # Returns the enddate of the publication of an internet vod if present.
-    def available_until(item)
-      return if item['predictions'].blank?
-      internetvod = item['predictions']
-        .find { |p| p['platform'] == 'INTERNETVOD' }
-      return unless internetvod
-      Timestamp.to_datetime(internetvod['publishStop'])
-    end
-
-    # Returns the index at which it is in the parent. When no
-    # :member_of keyword is given, it will return the first found
-    # index. Else, when a parent is found with matching member_of
-    # midref, it returns that index. Else returns nil.
-    # @param item The Poms Hash
-    # @param optional :member_of The midref of parent for which we
-    # seek the index
-    def position(item, member_of: nil)
-      parent(item, midref: member_of).try(:[], 'index')
-    end
-
-    # Finds a parent the data is "member of". If :midref is given, it
-    # will look for the parent that matches that mid and return nil if
-    # not found. Without the :midref it will return the first parent.
-    # @param item The Poms Hash
-    # @param optional midref The midref of parent we seek.
-    def parent(item, midref: nil)
-      if midref
-        parents(item).find { |parent| parent['midRef'] == midref }
-      else
-        parents(item).first
-      end
-    end
-
-    # Returns the parents that the element is member of. Will always
-    # return an array.
-    def parents(item)
-      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
-    # channel.
-    #
-    # @param item The Poms hash
-    def schedule_events(item)
-      events = item.fetch('scheduleEvents', [])
-      events = yield(events) if block_given?
-      events.map { |event| hash_event(event) }
-    end
-
-    # Turns the event into a hash.
-    def hash_event(event)
-      {
-        'starts_at' => Timestamp.to_datetime(event.fetch('start')),
-        'ends_at' => Timestamp.to_datetime(event.fetch('start') +
-          event.fetch('duration'))
-      }
-    end
-    private_class_method :hash_event
-
-    # Poms has arrays of hashes for some types that have a value and type. This
-    # is a way to access those simply.
-    #
-    # Example:
-    #    item = {'titles' => [{'value' => 'Main title', 'type' => 'MAIN'},
-    #           {'value' => 'Subtitle', 'type' => 'SUB'}] }
-    #    value_of_type(item, 'titles', 'MAIN') => 'Main title'
-    #
-    # @param item The Poms hash
-    # @param key The key of the array we want to look in
-    # @param type The type to select
-    def value_of_type(item, key, type)
-      return unless item && item[key]
-      res = item[key].find { |value| value['type'] == type }
-      return unless res
-      res['value']
-    end
-    private_class_method :value_of_type
+    extend Poms::Fields::Details
+    extend Poms::Fields::Media
+    extend Poms::Fields::Schedule
   end
 end

data/lib/poms/fields/details.rb

@@ -0,0 +1,98 @@
+require 'poms/timestamp'
+module Poms
+  module Fields
+    # Module to find details from for ex. attributes on poms items.
+    module Details
+      extend self
+
+      # Returns the title, main by default
+      def title(item, type = 'MAIN')
+        value_of_type(item, 'titles', type)
+      end
+
+      # Returns the description, main by default
+      def description(item, type = 'MAIN')
+        value_of_type(item, 'descriptions', type)
+      end
+
+      # Returns all the descendantOfs of the type given.
+      # @param item The Poms Hash
+      # @param type The type of descendantOfs we want
+      def descendants_of(item, type)
+        item['descendantOf'].select { |descendant| descendant['type'] == type }
+      end
+
+      def broadcasters(item)
+        Array(item['broadcasters']).map do |key_value_pair|
+          key_value_pair['value']
+        end
+      end
+
+      def mid(item)
+        item['mid']
+      end
+
+      # Returns the index at which it is in the parent. When no
+      # :member_of keyword is given, it will return the first found
+      # index. Else, when a parent is found with matching member_of
+      # midref, it returns that index. Else returns nil.
+      # @param item The Poms Hash
+      # @param optional :member_of The midref of parent for which we
+      # seek the index
+      def position(item, member_of: nil)
+        parent(item, midref: member_of).try(:[], 'index')
+      end
+
+      # Finds a parent the data is "member of". If :midref is given, it
+      # will look for the parent that matches that mid and return nil if
+      # not found. Without the :midref it will return the first parent.
+      # @param item The Poms Hash
+      # @param optional midref The midref of parent we seek.
+      def parent(item, midref: nil)
+        if midref
+          parents(item).find { |parent| parent['midRef'] == midref }
+        else
+          parents(item).first
+        end
+      end
+
+      # Returns the parents that the element is member of. Will always
+      # return an array.
+      def parents(item)
+        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
+
+      # Poms has arrays of hashes for some types that have a value and type.
+      # This is a way to access those simply.
+      #
+      # Example:
+      #    item = {'titles' => [{'value' => 'Main title', 'type' => 'MAIN'},
+      #           {'value' => 'Subtitle', 'type' => 'SUB'}] }
+      #    value_of_type(item, 'titles', 'MAIN') => 'Main title'
+      #
+      # @param item The Poms hash
+      # @param key The key of the array we want to look in
+      # @param type The type to select
+      def value_of_type(item, key, type)
+        return unless item && item[key]
+        res = item[key].find { |value| value['type'] == type }
+        return unless res
+        res['value']
+      end
+      private_class_method :value_of_type
+    end
+  end
+end

data/lib/poms/fields/media.rb

@@ -0,0 +1,34 @@
+module Poms
+  module Fields
+    # Module to retrieve media related information from poms items.
+    module Media
+      extend self
+
+      IMAGE_TYPE_PRIORITY = %w[PROMO_LANDSCAPE PICTURE].freeze
+
+      # Returns the images from the hash
+      def images(item)
+        item['images'].try(:sort_by) do |i|
+          image_order_index(i)
+        end
+      end
+
+      # 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
+
+      def image_order_index(image)
+        IMAGE_TYPE_PRIORITY.index(image['type']) || IMAGE_TYPE_PRIORITY.size
+      end
+
+      # Returns the id of the first image or nil if there are none.
+      def first_image_id(item)
+        return unless images(item)
+        image_id(images(item).first)
+      end
+    end
+  end
+end

data/lib/poms/fields/schedule.rb

@@ -0,0 +1,80 @@
+require 'poms/timestamp'
+
+module Poms
+  module Fields
+    # modeule to retrieve scheduling/timtable related information from
+    # poms items.
+    module Schedule
+      extend self
+
+      # Returns an array of odi stream types.
+      # Note: this code is copied from Broadcast
+      # and it is assumed it was working there.
+      def odi_streams(item)
+        locations = item['locations']
+        return [] if locations.nil? || locations.empty?
+        odi_streams = locations.select { |l| l['programUrl'].match(/^odi/) }
+        streams = odi_streams.map do |l|
+          l['programUrl'].match(%r{^[\w+]+\:\/\/[\w\.]+\/video\/(\w+)\/\w+})[1]
+        end
+        streams.uniq
+      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 channel.
+      #
+      # @param item The Poms hash
+      def schedule_events(item)
+        events = item.fetch('scheduleEvents', [])
+        events = yield(events) if block_given?
+        events.map { |event| hash_event(event) }
+      end
+
+      # Returns the first publication from an items location array which has
+      # INTERNETVOD and is PUBLISHED and does not have owner NEBO.
+      def publication(poms_item)
+        return if poms_item.fetch('locations', nil).blank?
+        poms_item.fetch('locations', []).find do |item|
+          item.fetch('platform', '') == 'INTERNETVOD' &&
+            item.fetch('workflow', '') == 'PUBLISHED' &&
+            item.fetch('owner', '') != 'NEBO'
+        end
+      end
+
+      # Return the publishStop datetime from a publication
+      def publish_stop(poms_item)
+        published_item = publication(poms_item)
+        return unless published_item
+        Timestamp.to_datetime(published_item['publishStop'])
+      end
+
+      # Return the publishStart datetime from a publication
+      def publish_start(poms_item)
+        published_item = publication(poms_item)
+        return unless published_item
+        Timestamp.to_datetime(published_item['publishStart'])
+      end
+
+      # Returns the enddate of the publication of an internet vod if present.
+      def available_until(item)
+        return if item['predictions'].blank?
+        internetvod = item['predictions']
+          .find { |p| p['platform'] == 'INTERNETVOD' }
+        return unless internetvod
+        Timestamp.to_datetime(internetvod['publishStop'])
+      end
+
+      # Turns the event into a hash.
+      def hash_event(event)
+        {
+          'starts_at' => Timestamp.to_datetime(event.fetch('start')),
+          'ends_at' => Timestamp.to_datetime(event.fetch('start') +
+            event.fetch('duration'))
+        }
+      end
+      private_class_method :hash_event
+    end
+  end
+end

data/lib/poms/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poms
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Tom Kruijsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -199,6 +199,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -210,7 +211,6 @@ files:
 - Rakefile
 - bin/rspec
 - bin/rubocop
-- circle.yml
 - examples/fetch.rb
 - examples/search.rb
 - lib/poms.rb
@@ -228,6 +228,9 @@ files:
 - lib/poms/configuration.rb
 - lib/poms/errors.rb
 - lib/poms/fields.rb
+- lib/poms/fields/details.rb
+- lib/poms/fields/media.rb
+- lib/poms/fields/schedule.rb
 - lib/poms/timestamp.rb
 - lib/poms/version.rb
 - poms.gemspec
@@ -250,8 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Interface to POMS CouchDB API

data/circle.yml

@@ -1,13 +0,0 @@
-machine:
-  ruby:
-    version: 2.3.4
-  timezone:
-    Europe/Amsterdam
-  environment:
-    POMS_KEY: key
-    POMS_ORIGIN: origin
-    POMS_SECRET: secret
-test:
-  override:
-    - bundle exec rubocop
-    - bundle exec rspec