bbc_redux 0.4.0.pre → 0.4.3.pre

data/README.md

@@ -1,3 +1,5 @@
+# THIS IS PRE RELEASE, DON'T USE IT AS IT PROBABLY WON'T WORK!
+
 # Redux
 
 A gem to help navigate the Redux API's and to screen scrape where an API does
@@ -59,7 +61,9 @@ to message us.
     asset.duration    #=> Integer
     asset.key         #=> BBC::Redux::Key
     asset.name        #=> String
+    asset.pcrid       #=> BBC::Redux::Crid
     asset.reference   #=> String
+    asset.scrid       #=> BBC::Redux::Crid
     asset.start       #=> DateTime
     asset.uuid        #=> String
 

data/lib/bbc/redux/asset.rb

@@ -1,5 +1,6 @@
 require 'virtus'
 require_relative 'channel'
+require_relative 'crid'
 require_relative 'key'
 require_relative 'media_url'
 
@@ -17,7 +18,9 @@ module BBC
     #   asset.duration    #=> Integer
     #   asset.key         #=> BBC::Redux::Key
     #   asset.name        #=> String
+    #   asset.pcrid       #=> BBC::Redux::Crid
     #   asset.reference   #=> String
+    #   asset.scrid       #=> BBC::Redux::Crid
     #   asset.start       #=> DateTime
     #   asset.uuid        #=> String
     #
@@ -71,15 +74,31 @@ module BBC
       alias :title :name
 
       # @!attribute [r] uuid
-      # @return [String] the user's uuid
+      # @return [String] the assets's uuid
       attribute :uuid, String
 
+      # @!attribute [r] crids
+      # @return [String] the assets's crids
+      attribute :crids, Array[BBC::Redux::Crid], :default => [ ]
+
       # @!attribute [r] key
       # @return [Key] the asset's access key object
       def key
         @key ||= Key.new(access_key)
       end
 
+      # @!attribute [r] pcrid
+      # @return [Key] the asset's programme crid
+      def pcrid
+        @pcrid ||= crids.find { |c| c.description =~ /programme/ }
+      end
+
+      # @!attribute [r] scrid
+      # @return [Key] the asset's series crid
+      def scrid
+        @scrid ||= crids.find { |c| c.description =~ /series/ }
+      end
+
       private
 
       def self.has_media_url(type)

data/lib/bbc/redux/client.rb

@@ -240,7 +240,7 @@ module BBC
       def url_for(action)
         case action
         when :asset
-          host + '/asset/details'
+          host + '/asset/details/extended'
         when :channels
           host + '/asset/channel/available'
         when :channel_categories

data/lib/bbc/redux/crid.rb

@@ -0,0 +1,41 @@
+require 'virtus'
+require_relative 'channel'
+require_relative 'key'
+require_relative 'media_url'
+
+module BBC
+  module Redux
+
+    # Redux Crid Object
+    #
+    # @example Properties of the crid object
+    #
+    #   crid = redux_client.asset('5966413090093319525').pcrid
+    #
+    #   crid.content      #=> String
+    #   crid.description  #=> String
+    #   crid.type         #=> String
+    #
+    # @author Matt Haynes <matt.haynes@bbc.co.uk>
+    class Crid
+
+      include Virtus.value_object
+
+      # @!attribute [r] content
+      # @return [String] the crids content, e.g. crid://fp.bbc.co.uk/LYRJ9T
+      attribute :content, String
+
+      alias :to_s :content
+
+      # @!attribute [r] description
+      # @return [String] the crid's description, e.g. "DTG series CRID"
+      attribute :description, String
+
+      # @!attribute [r] type
+      # @return [String] the crid's type byte value, e.g. "0x32"
+      attribute :type, String
+
+    end
+
+  end
+end

data/lib/bbc/redux/serializers.rb

@@ -28,6 +28,18 @@ module BBC
           property :name
           property :display_name
         end
+
+        # NB, special compensation for api returning crids: nil not crids: []
+        crid_reader = lambda { |doc, args|
+          self.crids = (doc['crids'] || []).map {|c| BBC::Redux::Crid.new(c) }
+        }
+
+        collection :crids, :reader => crid_reader do
+          property :content
+          property :description
+          property :type
+        end
+
       end
 
       class Channel < Representable::Decorator

data/lib/bbc/redux/version.rb

@@ -2,7 +2,7 @@ module BBC
   module Redux
 
     # Library version
-    VERSION = '0.4.0.pre'
+    VERSION = '0.4.3.pre'
 
   end
 end

data/lib/bbc/redux.rb

@@ -2,6 +2,7 @@ require_relative 'redux/asset'
 require_relative 'redux/channel'
 require_relative 'redux/channel_category'
 require_relative 'redux/client'
+require_relative 'redux/crid'
 require_relative 'redux/end_points'
 require_relative 'redux/key'
 require_relative 'redux/media_url'

data/spec/bbc/redux/asset_spec.rb

@@ -16,6 +16,16 @@ describe BBC::Redux::Asset do
     'channel.class'        => BBC::Redux::Channel,
     'channel.display_name' => 'CBeebies',
     'channel.name'         => 'cbeebies',
+    'pcrid.class'          => BBC::Redux::Crid,
+    'pcrid.content'        => 'crid://fp.bbc.co.uk/4CBRMV',
+    'pcrid.description'    => 'DTG programme CRID',
+    'pcrid.to_s'           => 'crid://fp.bbc.co.uk/4CBRMV',
+    'pcrid.type'           => '0x31',
+    'scrid.class'          => BBC::Redux::Crid,
+    'scrid.content'        => 'crid://fp.bbc.co.uk/LYRJ9T',
+    'scrid.description'    => 'DTG series CRID',
+    'scrid.to_s'           => 'crid://fp.bbc.co.uk/LYRJ9T',
+    'scrid.type'           => '0x32',
     :access_key            => '1-1397227462-ba632af7af1ad',
     :description           => 'Animated adventures of Pingu. [S]',
     :disk_reference        => '5966413090093319525',

data/spec/bbc/redux/client_spec.rb

@@ -92,7 +92,7 @@ describe BBC::Redux::Client do
 
     it 'takes json from the backend HTTP API and generates an asset object' do
       expect(http_client).to \
-        receive(:post).with('https://i.bbcredux.com/asset/details', {
+        receive(:post).with('https://i.bbcredux.com/asset/details/extended', {
           :body           => { :reference => reference, :token => token },
           :followlocation => true,
         }).and_return(resp)
@@ -104,7 +104,7 @@ describe BBC::Redux::Client do
 
     it 'works when given a UUID rather than a disk reference' do
       expect(http_client).to \
-        receive(:post).with('https://i.bbcredux.com/asset/details', {
+        receive(:post).with('https://i.bbcredux.com/asset/details/extended', {
           :body           => { :uuid => uuid, :token => token },
           :followlocation => true,
         }).and_return(resp)

data/spec/fixtures/asset.json

@@ -1,24 +1,36 @@
 {
-   "name" : "Pingu",
-   "channel" : {
-      "name" : "cbeebies",
-      "display_name" : "CBeebies"
-   },
-   "uuid" : "26a141fc-8511-4fef-aa2b-af1d1de5a75a",
-   "description" : "Animated adventures of Pingu. [S]",
-   "tags" : [
-      { 
-         "text" : "penguin"
-      },
-      {
-         "text" : "not_stoat"
-      }
-   ],
-   "key" : "1-1397227462-ba632af7af1ad",
-   "timing" : {
-      "duration" : 300,
-      "start" : "2014-01-08 06:50:00 +0000"
-   },
-   "reference" : 5966413090093319525
+  "crids" : [
+    {
+    "content" : "crid://fp.bbc.co.uk/LYRJ9T",
+    "type" : "0x32",
+    "description" : "DTG series CRID"
+  },
+  {
+    "content" : "crid://fp.bbc.co.uk/4CBRMV",
+    "type" : "0x31",
+    "description" : "DTG programme CRID"
+  }
+  ],
+  "name" : "Pingu",
+  "channel" : {
+    "name" : "cbeebies",
+    "display_name" : "CBeebies"
+  },
+  "uuid" : "26a141fc-8511-4fef-aa2b-af1d1de5a75a",
+  "description" : "Animated adventures of Pingu. [S]",
+  "tags" : [
+    { 
+    "text" : "penguin"
+  },
+  {
+    "text" : "not_stoat"
+  }
+  ],
+  "key" : "1-1397227462-ba632af7af1ad",
+  "timing" : {
+    "duration" : 300,
+    "start" : "2014-01-08 06:50:00 +0000"
+  },
+  "reference" : 5966413090093319525
 }
 

data/spec/integration/bbc_redux_spec.rb

@@ -30,6 +30,20 @@ describe BBC::Redux do
     expect(asset.start).to eq(DateTime.parse('2014-01-08 06:50:00 +0000'))
     expect(asset.uuid).to eq('26a141fc-8511-4fef-aa2b-af1d1de5a75a')
 
+    # Test crids
+    expect(asset.pcrid.class).to eq(BBC::Redux::Crid)
+    expect(asset.pcrid.content).to eq('crid://fp.bbc.co.uk/4CBRMV')
+    expect(asset.pcrid.description).to eq('DTG programme CRID')
+    expect(asset.pcrid.type).to eq('0x31')
+
+    expect(asset.scrid.class).to eq(BBC::Redux::Crid)
+    expect(asset.scrid.content).to eq('crid://fp.bbc.co.uk/LYRJ9T')
+    expect(asset.scrid.description).to eq('DTG series CRID')
+    expect(asset.scrid.type).to eq('0x32')
+
+    # Special test for broken crid response
+    expect(client.asset('5203338276492306280').crids).to eq([])
+
     # Test media url
     resp = client.http.head(asset.flv_url)
     expect(resp.code).to eq(200)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bbc_redux
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre
+  version: 0.4.3.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -159,6 +159,7 @@ files:
 - lib/bbc/redux/channel.rb
 - lib/bbc/redux/channel_category.rb
 - lib/bbc/redux/client.rb
+- lib/bbc/redux/crid.rb
 - lib/bbc/redux/end_points.rb
 - lib/bbc/redux/key.rb
 - lib/bbc/redux/media_url.rb
@@ -195,6 +196,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1134618896184121202
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: