bbc_redux 0.4.0.pre

data/spec/bbc/redux/media_url_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe BBC::Redux::MediaUrl do
+
+  BBC::Redux::MediaUrl::TEMPLATES.each do |type|
+    it "should initialize correctly when given a the #{type} type" do
+      expect { generate_url :type => type }.to_not raise_error
+    end
+  end
+
+  it 'should not initialize when given an invalid transcode type' do
+    expect { generate_url :type => :foobar }.to raise_error
+  end
+
+  describe '#end_point' do
+
+    it 'allows includes the host' do
+      BBC::Redux::MediaUrl::TEMPLATES.each do |type|
+        url = generate_url :type => type
+        expect(url.end_point).to match(/^https:\/\/i.bbcredux.com\/asset/)
+      end
+    end
+
+    it 'allows you to specify an explicit filename' do
+      BBC::Redux::MediaUrl::TEMPLATES.each do |type|
+        url = generate_url :type => type
+        expect(url.end_point('foobar.file')).to match(/foobar\.file$/)
+      end
+    end
+
+    it 'has correct value when we\'re an dvbsubs url' do
+      url = generate_url :type => :dvbsubs, :identifier => 'abc'
+      expect(url.end_point).to \
+        match(/\/asset\/media\/abc\/#{url.key.value}\/dvbsubs\/abc.xml$/)
+    end
+
+    it 'has correct value when we\'re an flv url' do
+      url = generate_url :type => :flv, :identifier => 'abc'
+      expect(url.end_point).to \
+        match(/\/asset\/media\/abc\/#{url.key.value}\/Flash_v1.0\/abc.flv$/)
+    end
+
+    it 'has correct value when we\'re an h264_hi url' do
+      url = generate_url :type => :h264_hi, :identifier => 'abc'
+      expect(url.end_point).to \
+        match(/\/asset\/media\/abc\/#{url.key.value}\/h264_mp4_hi_v1.1\/abc-h264lg.mp4$/)
+    end
+
+    it 'has correct value when we\'re an h264_lo url' do
+      url = generate_url :type => :h264_lo, :identifier => 'abc'
+      expect(url.end_point).to \
+        match(/\/asset\/media\/abc\/#{url.key.value}\/h264_mp4_lo_v1.0\/abc-h264sm.mp4$/)
+    end
+
+    it 'has correct value when we\'re an mp3 url' do
+      url = generate_url :type => :mp3, :identifier => 'abc'
+      expect(url.end_point).to \
+        match(/\/asset\/media\/abc\/#{url.key.value}\/MP3_v1.0\/abc.mp3$/)
+    end
+
+    it 'has correct value when we\'re a ts url' do
+      url = generate_url :type => :ts, :identifier => 'abc'
+      expect(url.end_point).to \
+        match(/\/asset\/media\/abc\/#{url.key.value}\/ts\/abc.mpegts$/)
+    end
+
+    it 'has correct value when we\'re a ts_stripped url' do
+      url = generate_url :type => :ts_stripped, :identifier => 'abc'
+      expect(url.end_point).to \
+        match(/\/asset\/media\/abc\/#{url.key.value}\/strip\/abc-stripped.mpegts$/)
+    end
+  end
+
+  describe '#to_s' do
+    it 'should be the same as #end_point' do
+      url = generate_url
+      expect(url.to_s).to eq(url.end_point)
+    end
+  end
+
+  describe '#expires_at' do
+    it 'should be the same as the key\'s expires at time' do
+      time = Time.now
+      expect(generate_url(:expires_at => time).expires_at.to_time.to_i).to \
+        be(time.to_i)
+    end
+  end
+
+  describe '#expired?' do
+    it 'should be true when expires_at is in the past' do
+      expect(generate_url(:expires_at => Time.now - 300).expired?).to be(true)
+    end
+
+    it 'should be false when expires_at is in the future' do
+      expect(generate_url(:expires_at => Time.now + 300).expired?).to be(false)
+    end
+  end
+
+  describe '#live?' do
+    it 'should be false when expires_at is in the past' do
+      expect(generate_url(:expires_at => Time.now - 300).live?).to be(false)
+    end
+
+    it 'should be true when expires_at is in the future' do
+      expect(generate_url(:expires_at => Time.now + 300).live?).to be(true)
+    end
+  end
+
+  describe '#ttl' do
+    it 'should return the key\'s TLL in seconds' do
+      expect(generate_url.ttl).to be_within(1).of(0)
+    end
+  end
+
+  describe '#==' do
+    it 'should be true if urls have same identifier, type and key' do
+      expect(generate_url).to eq(generate_url)
+    end
+
+    it 'should be false if urls have different identifiers' do
+      expect(generate_url).to_not eq(generate_url(:identifier => '54321'))
+    end
+
+    it 'should be false if urls have different types' do
+      expect(generate_url).to_not eq(generate_url(:type => :dvbsubs))
+    end
+
+    it 'should be false if urls have different keys' do
+      expect(generate_url).to_not eq(generate_url(:expires_at => Time.now - 10))
+    end
+
+    it 'should be false if other key is something else' do
+      expect(generate_url).to_not eq(:something_else)
+    end
+  end
+
+  private
+
+  def generate_url(options = { })
+    identifier = options[:identifier] || '12345'
+    expires_at = options[:expires_at] || Time.now
+    type       = options[:type] || :mp3
+    described_class.new( identifier, type, generate_key(expires_at) )
+  end
+
+  def generate_key(expires_at = Time.now)
+    BBC::Redux::Key.new "1-#{expires_at.to_i}-ba632af7af1adb6f96dbeceb83331ad6"
+  end
+
+end
+

data/spec/bbc/redux/search_results_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe BBC::Redux::SearchResults do
+
+  let(:json)   { read_fixture 'search_results.json'      }
+
+  let(:mapper) { BBC::Redux::Serializers::SearchResults  }
+
+  let(:object) { described_class.new                     }
+
+  subject      { mapper.new(object).from_json(json)      }
+
+  {
+
+    # attr / method => expected_value
+    'created_at'     => DateTime.parse('2014-04-15 17:35:42 +0100'),
+    'offset'         => 10,
+    'query_time'     => 0.166,
+    'total'          => 25435,
+    'total_returned' => 10,
+
+  }.each_pair do |attribute, value|
+    its(attribute) { should eq(value) }
+  end
+
+  describe '#assets' do
+    it 'should represent the assets listed in the results' do
+      expect(subject.assets.size).to be(10)
+      expect(subject.assets.first.name).to eq("Bargain Hunt")
+
+      expect(subject.assets.first.uuid).to \
+        eq('87ba761a-2fb7-4437-a7bd-f358269e537c')
+
+      expect(subject.assets.first.description).to \
+        eq('Edinburgh: Bargain Hunt visits Scotland\'s capital')
+
+      expect(subject.assets.first.key).to \
+        eq(BBC::Redux::Key.new('1-1397666142-936014a77cbe46ada46c2e114676a86b'))
+
+
+      expect(subject.assets.first.start).to \
+        eq(DateTime.parse('2014-04-15 12:15:00 +0100'))
+
+      expect(subject.assets.first.channel.name).to eq('bbcone')
+      expect(subject.assets.first.duration).to eq(2700)
+      expect(subject.assets.first.reference).to eq('6002476641954360370')
+
+    end
+  end
+
+  describe '#has_more?' do
+    it 'should be false when offset + total_returned >= total' do
+      results = described_class.new({
+        :offset => 20, :total_returned => 10, :total => 30
+      })
+
+      expect(results.has_more?).to be(false)
+    end
+
+    it 'should be true when offset + total_returned < total' do
+      results = described_class.new({
+        :offset => 20, :total_returned => 10, :total => 40
+      })
+
+      expect(results.has_more?).to be(true)
+    end
+  end
+
+end

data/spec/bbc/redux/user_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe BBC::Redux::User do
+
+  let(:json)   { read_fixture 'user.json'         }
+
+  let(:user)   { described_class.new              }
+
+  let(:mapper) { BBC::Redux::Serializers::User    }
+
+  subject      { mapper.new(user).from_json(json) }
+
+  {
+
+    # attribute_name    => expected_value
+    :can_invite         => false,
+    :can_invite?        => false,
+    :created            => DateTime.parse('2008-01-01 01:01:01 +0000'),
+    :department         => 'My Department',
+    :division           => 'My Division',
+    :email              => 'mail@example.com',
+    :first_name         => 'Jane',
+    :id                 => 1234,
+    :last_name          => 'Smith',
+    :legal_accepted     => false,
+    :legal_html         => '<h1>Action Required</h1>',
+    :must_sign_terms?   => true,
+    :name               => 'Jane Smith',
+    :permitted_services => [ 'uk.bbc.radio', 'uk.bbc.tv' ],
+    :username           => 'jsmith',
+    :uuid               => 'eac522fe-313a-453e-97b0-d33e6fd50c62'
+
+  }.each_pair do |attribute, value|
+    its(attribute) { should eq(value) }
+  end
+
+end

data/spec/fixtures/asset.json

@@ -0,0 +1,24 @@
+{
+   "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/fixtures/channel_categories.json

@@ -0,0 +1,28 @@
+[
+   {
+      "priority" : 1000,
+      "id" : 1,
+      "description" : "BBC TV"
+   },
+   {
+      "priority" : 2000,
+      "id" : 2,
+      "description" : "BBC Radio"
+   },
+   {
+      "priority" : 3000,
+      "id" : 3,
+      "description" : "BBC HD"
+   },
+   {
+      "priority" : 4000,
+      "id" : 4,
+      "description" : "BBC Olympics"
+   },
+   {
+      "priority" : 5000,
+      "id" : 5,
+      "description" : "BBC Olympics HD"
+   }
+]
+

data/spec/fixtures/channels.json

@@ -0,0 +1,51 @@
+[
+   {
+      "longname" : "BBC One",
+      "name" : "bbcone",
+      "category" : 1,
+      "sortorder" : 1010
+   },
+   {
+      "longname" : "BBC Two",
+      "name" : "bbctwo",
+      "category" : 1,
+      "sortorder" : 1020
+   },
+   {
+      "longname" : "BBC Three",
+      "name" : "bbcthree",
+      "category" : 1,
+      "sortorder" : 1030
+   },
+   {
+      "longname" : "BBC Four",
+      "name" : "bbcfour",
+      "category" : 1,
+      "sortorder" : 1040
+   },
+   {
+      "longname" : "Radio 1",
+      "name" : "bbcr1",
+      "category" : 2,
+      "sortorder" : 2010
+   },
+   {
+      "longname" : "Radio 1 Xtra",
+      "name" : "bbc1x",
+      "category" : 2,
+      "sortorder" : 2015
+   },
+   {
+      "longname" : "Radio 2",
+      "name" : "bbcr2",
+      "category" : 2,
+      "sortorder" : 2020
+   },
+   {
+      "longname" : "Radio 3",
+      "name" : "bbcr3",
+      "category" : 2,
+      "sortorder" : 2030
+   }
+]
+

data/spec/fixtures/search_results.json

@@ -0,0 +1,172 @@
+{
+   "total_returned" : 10,
+   "total_found" : 25435,
+   "time" : "2014-04-15 17:35:42 +0100",
+   "elapsed" : "0.166",
+   "results" : {
+      "assets" : [
+         {
+            "name" : "Bargain Hunt",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "87ba761a-2fb7-4437-a7bd-f358269e537c",
+            "description" : "Edinburgh: Bargain Hunt visits Scotland's capital",
+            "tags" : [],
+            "key" : "1-1397666142-936014a77cbe46ada46c2e114676a86b",
+            "timing" : {
+               "duration" : 2700,
+               "start" : "2014-04-15 12:15:00 +0100"
+            },
+            "reference" : 6002476641954360370
+         },
+         {
+            "name" : "Bargain Hunt",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "0d3846b5-4e65-48af-8fd3-9cad2fe7ff1b",
+            "description" : "Edinburgh: Bargain Hunt visits Scotland's capital, where two teams compete to see who can make the most money at auction. Their experts are Charles Hanson and David Barby. [AD,S]",
+            "tags" : [],
+            "key" : "1-1397666142-936014a77cbe46ada46c2e114676a86b",
+            "timing" : {
+               "duration" : 2700,
+               "start" : "2014-04-15 12:15:00 +0100"
+            },
+            "reference" : 6002476641954360370
+         },
+         {
+            "name" : "Saints and Scroungers",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "56e11e2e-e20f-4317-bd22-e74274f4bd69",
+            "description" : "2/20. The case of an apparently jobless single mother who may be better off than she lets on. Also in HD. [S]",
+            "tags" : [],
+            "key" : "1-1397666142-66d9c463c8e9540cd5ef3adf9685bee8",
+            "timing" : {
+               "duration" : 1800,
+               "start" : "2014-04-15 11:45:00 +0100"
+            },
+            "reference" : 6002468911013227569
+         },
+         {
+            "name" : "Saints and Scroungers",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "82708c0e-3291-42e2-af24-05be0da52ef4",
+            "description" : "2/20. The case of an apparently jobless single mother who may be better off than she lets on. Also in HD. [S]",
+            "tags" : [],
+            "key" : "1-1397666142-66d9c463c8e9540cd5ef3adf9685bee8",
+            "timing" : {
+               "duration" : 1800,
+               "start" : "2014-04-15 11:45:00 +0100"
+            },
+            "reference" : 6002468911013227569
+         },
+         {
+            "name" : "Don't Get Done, Get Dom",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "b6bd69a5-bce9-4d47-b84a-0f6aec376465",
+            "description" : "12/20. Second-Hand Cars: Dom helps two people who have had problems with the same used car firm. Also in HD. [AD,S]",
+            "tags" : [],
+            "key" : "1-1397666142-a0db7b01836077cac16d36b79f237e33",
+            "timing" : {
+               "duration" : 2700,
+               "start" : "2014-04-15 11:00:00 +0100"
+            },
+            "reference" : 6002457314601528368
+         },
+         {
+            "name" : "Homes Under the Hammer",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "208c76d5-9746-4b55-9df7-f1095f6f1550",
+            "description" : "Martin Roberts and Lucy Alexander visit a renovation project in Maidstone, a one-bedroom flat in Salford and a house in Stoke with an outside toilet. [S]",
+            "tags" : [],
+            "key" : "1-1397666142-70ea4d07c926321bffb402537d15487a",
+            "timing" : {
+               "duration" : 3600,
+               "start" : "2014-04-15 10:00:00 +0100"
+            },
+            "reference" : 6002441852719262767
+         },
+         {
+            "name" : "Homes Under the Hammer",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "b49c3134-0503-4cb9-a34b-30b897b85b75",
+            "description" : "Martin Roberts and Lucy Alexander visit a renovation project in Maidstone, a one-bedroom flat in Salford and a house in Stoke with an outside toilet. [S]",
+            "tags" : [],
+            "key" : "1-1397666142-70ea4d07c926321bffb402537d15487a",
+            "timing" : {
+               "duration" : 3600,
+               "start" : "2014-04-15 10:00:00 +0100"
+            },
+            "reference" : 6002441852719262767
+         },
+         {
+            "name" : "Helicopter Heroes: New Cases",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "9bc480dd-1aa5-4691-9232-eb15e5c591db",
+            "description" : "Series following the Yorkshire Air Ambulance. An eight-year-old boy is stabbed and the helimed team must save him. Meanwhile, a DIY enthusiast's dream home almost kills him. Also in HD. [AD,S]",
+            "tags" : [],
+            "key" : "1-1397666142-46f6ffef86e3739bfbff302fcd1ce666",
+            "timing" : {
+               "duration" : 2700,
+               "start" : "2014-04-15 09:15:00 +0100"
+            },
+            "reference" : 6002430256307566003
+         },
+         {
+            "name" : "Breakfast",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "245bca49-1595-4d6d-bdb2-9b737018adc5",
+            "description" : "The latest news, sport, business and weather from the BBC's Breakfast team. Also in HD. [S] Including regional news at 25 and 55 minutes past each hour.",
+            "tags" : [],
+            "key" : "1-1397666142-d092e33e62085fc099c2b704c5f7ee11",
+            "timing" : {
+               "duration" : 11700,
+               "start" : "2014-04-15 06:00:00 +0100"
+            },
+            "reference" : 6002380005190200365
+         },
+         {
+            "name" : "Breakfast",
+            "channel" : {
+               "name" : "bbcone",
+               "display_name" : "BBC One"
+            },
+            "uuid" : "279e9823-c335-46bf-a39e-b015487886e2",
+            "description" : "The latest news, sport, business and weather from the BBC's Breakfast team. Also in HD. [S] Including regional news at 25 and 55 minutes past each hour.",
+            "tags" : [],
+            "key" : "1-1397666142-d092e33e62085fc099c2b704c5f7ee11",
+            "timing" : {
+               "duration" : 11700,
+               "start" : "2014-04-15 06:00:00 +0100"
+            },
+            "reference" : 6002380005190200365
+         }
+      ]
+   },
+   "offset" : "10"
+}
+

data/spec/fixtures/user.json

@@ -0,0 +1,22 @@
+{
+  "created": "2008-01-01 01:01:01 +0000",
+  "can_invite": false,
+  "permitted_services": [
+    "uk.bbc.radio",
+    "uk.bbc.tv"
+  ],
+  "legal": {
+    "legal_html": "<h1>Action Required</h1>",
+    "accepted": 0
+  },
+  "id": 1234,
+  "details": {
+    "email":      "mail@example.com",
+    "department": "My Department",
+    "division":   "My Division",
+    "name":       "Jane Smith",
+    "username":   "jsmith"
+  },
+  "uuid": "eac522fe-313a-453e-97b0-d33e6fd50c62"
+}
+

data/spec/integration/bbc_redux_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe BBC::Redux do
+
+  let(:username) { @username ||= ask('Please enter redux user: ')       }
+  let(:password) { @password ||= ask('Please enter redux pass: ', true) }
+
+  it 'should work' do
+
+    client = BBC::Redux::Client.new({
+      :username => username, :password => password,
+    })
+
+    # Test Asset
+    asset = client.asset('5966413090093319525')
+
+    expect(asset.channel.class).to eq(BBC::Redux::Channel)
+    expect(asset.channel.display_name).to eq('CBeebies')
+    expect(asset.channel.name).to eq('cbeebies')
+
+    expect(asset.description).to eq('Pingu\'s Moon Adventure: Animated ' +
+      'adventures of Pingu, the clumsy young penguin. Pingu wants to visit' +
+      ' the moon so he makes a rocket out of an old barrel, tin foil and' +
+      ' snow. [S]')
+
+    expect(asset.disk_reference).to eq('5966413090093319525')
+    expect(asset.duration).to eq(300)
+    expect(asset.key.class).to eq(BBC::Redux::Key)
+    expect(asset.name).to eq('Pingu')
+    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 media url
+    resp = client.http.head(asset.flv_url)
+    expect(resp.code).to eq(200)
+
+    # Test channels
+    channels = client.channels
+
+    expect(channels.first.class).to eq(BBC::Redux::Channel)
+
+    # Test search
+    results = client.search(:limit => 100, :channel => [ 'bbcone', 'bbctwo' ])
+
+    ones = results.assets.select {|a| a.channel.name == 'bbcone' }
+    twos = results.assets.select {|a| a.channel.name == 'bbctwo' }
+
+    # Channel array query thing works
+    expect(ones.size > 0).to eq(true)
+    expect(twos.size > 0).to eq(true)
+    expect(ones.size + twos.size).to eq(results.assets.size)
+
+    # Test channel_categories
+    categories = client.channel_categories
+
+    expect(categories.first.class).to eq(BBC::Redux::ChannelCategory)
+
+    # Test user
+    user = client.user
+
+    expect(user.username).to eq(username)
+    expect(user.class).to eq(BBC::Redux::User)
+
+    # Test logout
+    expect(client.logout).to be(nil)
+  end
+
+  private
+
+  def ask(question, quietly = false)
+    print question
+    system 'stty -echo' if quietly
+    answer = $stdin.gets.chomp
+    system 'stty echo' if quietly
+    return answer
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$: << File.join( File.dirname(__FILE__), '..', 'lib' )
+
+require 'rspec'
+require 'rspec/its'
+require 'bbc/redux'
+
+RSpec.configure do |config|
+  config.order = 'random'
+
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+
+  def read_fixture(fname)
+    File.read File.join( File.dirname(__FILE__), 'fixtures', fname )
+  end
+
+end