bbc_redux 0.4.0.pre

data/AUTHORS

@@ -0,0 +1,8 @@
+AUTHORS
+
+British Broadcasting Corporation
+--------------------------------
+
+- Matt Haynes <matt.haynes@bbc.co.uk>
+- James Harrison <james.harrison2@bbc.co.uk>
+- Anuj Dutta

data/COPYING

@@ -0,0 +1,212 @@
+(c) 2013 British Broadcasting Corporation and contributors
+
+    See "AUTHORS" file for full details.
+
+    All code here, except where otherwise indicated, is licensed under
+    the Apache Licence version 2.0.
+
+----------------------------------------------------------------------------
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the
+      purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control
+      systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,174 @@
+# Redux
+
+A gem to help navigate the Redux API's and to screen scrape where an API does
+not exist.
+
+If you're reading this and you're not a BBC developer or authorised contractor
+then it probably won't make much sense.
+
+BBC Snippets and BBC Redux are tools designed to allow BBC staff to develop new
+ways to view and navigate content. As such, they're not open to the public.
+
+If you've been contracted by the BBC to do work in this area please feel free
+to message us.
+
+## Installation
+
+### Bundler
+
+    gem 'bbc_redux'
+
+### RubyGems
+
+    gem install bbc_redux
+
+## Quick Start
+
+    require 'bbc/redux'
+
+    # Login
+
+    client = BBC::Redux::Client.new({
+      :username => 'username',
+      :password => 'password',
+    })
+
+    # User data
+
+    user = client.user
+    
+    user.can_invite?  #=> Boolean
+    user.created      #=> DateTime
+    user.email        #=> String
+    user.first_name   #=> String
+    user.id           #=> Integer
+    user.last_name    #=> String
+    user.username     #=> String
+    user.uuid         #=> String
+
+    # Available Channels
+
+    client.channels   #=> Array<BBC::Redux::Channel>
+
+    # Asset data
+
+    asset = client.asset('5966413090093319525')
+    
+    asset.channel     #=> BBC::Redux::Channel
+    asset.description #=> String
+    asset.duration    #=> Integer
+    asset.key         #=> BBC::Redux::Key
+    asset.name        #=> String
+    asset.reference   #=> String
+    asset.start       #=> DateTime
+    asset.uuid        #=> String
+
+    # Media file urls ...
+
+    # These are wrappers around an http url, each url is valid for 24 hours and
+    # can be used without a session token
+
+    asset.dvbsubs_url     #=> BBC::Redux::MediaUrl
+    asset.flv_url         #=> BBC::Redux::MediaUrl
+    asset.h264_hi_url     #=> BBC::Redux::MediaUrl
+    asset.h264_lo_url     #=> BBC::Redux::MediaUrl
+    asset.mp3_url         #=> BBC::Redux::MediaUrl
+    asset.ts_url          #=> BBC::Redux::MediaUrl
+    asset.ts_stripped_url #=> BBC::Redux::MediaUrl
+
+    # URL helper methods
+
+    url = asset.mp3_url
+    
+    url.expired?   #=> Boolean
+    url.expires_at #=> DateTime
+    url.live?      #=> Boolean
+    url.ttl        #=> Integer
+    url.end_point  #=> String
+
+    # Generate an HTTP URL with a different filename
+    
+    url.end_point('myfile.mp3') #=> String
+    
+    # Download a file
+    response  = redux.http.get(url.end_point)
+
+    # Do something with response
+    response.code     # 200 (you can but hope!)
+    response.headers  # Hash
+    response.body     # Your file or string
+
+    # Get schedule
+    client.schedule(Date.today).each do |asset|
+      p asset.reference
+    end
+
+    # Get a schedule for specific channels
+    schedule = client.schedule(Date.today, [ 'bbcone', 'bbctwo' ])
+
+    # Search 
+
+    results = client.search(:name => 'Pingu')
+    
+    results.created_at     #=> DateTime
+    results.query          #=> Hash
+    results.query_time     #=> Float
+    results.assets         #=> Array<BBC::Redux::Asset>
+    results.total          #=> Integer
+    results.total_returned #=> Integer
+    results.has_more?      #=> Boolean
+
+    # Iterating all search results
+
+    results = redux_client.search(:name => 'Pingu', :offset => 0)
+
+    while true do
+      results.assets.each do |asset|
+        puts asset.name
+      end
+
+      if results.has_more?
+        next_query = results.query.merge({
+          :offset => results.query[:offset] + 10
+        })
+
+        results = redux_client.search(next_query)
+      else
+        break
+      end
+    end
+
+    # Remembering to logout whe your done
+
+    client.logout
+
+## Documentation
+
+Please see the ruby docs for full project documentation:
+
+http://rubydoc.info/github/bbcsnippets/redux-client-ruby/version-4/frames
+
+## Caveats / Known Issues
+
+### Using a proxy server
+
+The client uses [Typhoeus](https://github.com/dbalatero/typhoeus) which
+respects the `http_proxy` environment variable
+
+### "Your account has been comprimised"
+
+You might get your account locked if you repeatedly login, especially from
+multiple IP's. To be on the safe side you should reuse the `token` assigned to
+a client.
+
+Also, always remember to use `client.logout` when you are finished.
+
+## Development
+
+Please send new code in the form of a pull requests with tests. Run the current
+test suite with ...
+
+    rake coverage     # Generate code coverage report
+    rake doc          # Gennerate docs
+    rake integration  # Runs spec/integration/*_spec.rb - actually connects to redux
+    rake spec         # Runs spec/**/*_spec.rb

data/Rakefile

@@ -0,0 +1,47 @@
+################################################################################
+# Test Tasks
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/bbc/**/*_spec.rb']
+end
+
+desc 'Run integration tests (requires redux login)'
+RSpec::Core::RakeTask.new(:integration) do |spec|
+  spec.pattern = FileList['spec/integration/**/*_spec.rb']
+end
+
+desc 'Open coverage report'
+task :coverage do
+  sh 'open coverage/index.html'
+end
+
+################################################################################
+# Documentation Tasks
+
+require 'yard'
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = [ 'lib/bbc/**/*.rb' ]
+  t.options = [
+    '--no-private',
+    '--output-dir', 'docs/yard',
+    '--readme', 'README.md'
+  ]
+end
+
+################################################################################
+# Gem building Tasks
+
+namespace :gem do
+
+  desc 'Build gem file'
+  task :build do
+    sh 'bundle exec gem build bbc_redux.gemspec'
+  end
+
+end
+

data/bbc_redux.gemspec

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+
+$: << File.join( File.dirname(__FILE__), 'lib' )
+
+require 'rake'
+require 'bbc/redux/version'
+
+Gem::Specification.new do |gem|
+
+  # Meta data
+
+  gem.name        = 'bbc_redux'
+  gem.version     = BBC::Redux::VERSION
+  gem.summary     = 'A Ruby client for BBC Redux',
+  gem.description = 'A gem to help navigate the BBC Redux API'
+  gem.homepage    = 'https://www.bbcredux.com'
+  gem.license     = 'Apache'
+
+  gem.authors     = [
+    'JamesHarrison',
+    'andhapp',
+    'matth'
+  ]
+
+  gem.email       = [
+    'james.harrison@bbc.co.uk',
+    'matt.haynes@bbc.co.uk'
+  ]
+
+  # Files / paths
+
+  gem.files       = FileList[
+    'AUTHORS',
+    'COPYING',
+    'Gemfile',
+    'README.md',
+    'Rakefile',
+    'bbc_redux.gemspec',
+    'lib/**/*'
+  ]
+
+  gem.test_files    = FileList[ 'spec/**/*' ]
+
+  gem.require_paths = [ 'lib' ]
+
+  # Development dependencies
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'simplecov', '>= 0.8.2'
+  gem.add_development_dependency 'yard'
+
+  # Runtime dependencies
+
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'representable'
+  gem.add_dependency 'typhoeus', '>= 0.6.8'
+  gem.add_dependency 'virtus', '>= 0.5.0'
+
+end
+

data/lib/bbc/redux/asset.rb

@@ -0,0 +1,119 @@
+require 'virtus'
+require_relative 'channel'
+require_relative 'key'
+require_relative 'media_url'
+
+module BBC
+  module Redux
+
+    # Redux API Asset Object
+    #
+    # @example Properties of the asset object
+    #
+    #   asset = redux_client.asset('5966413090093319525')
+    #
+    #   asset.channel     #=> BBC::Redux::Channel
+    #   asset.description #=> String
+    #   asset.duration    #=> Integer
+    #   asset.key         #=> BBC::Redux::Key
+    #   asset.name        #=> String
+    #   asset.reference   #=> String
+    #   asset.start       #=> DateTime
+    #   asset.uuid        #=> String
+    #
+    # @example Generating urls for the asset's associated media files
+    #
+    #   asset.dvbsubs_url     #=> BBC::Redux::MediaUrl
+    #   asset.flv_url         #=> BBC::Redux::MediaUrl
+    #   asset.h264_hi_url     #=> BBC::Redux::MediaUrl
+    #   asset.h264_lo_url     #=> BBC::Redux::MediaUrl
+    #   asset.mp3_url         #=> BBC::Redux::MediaUrl
+    #   asset.ts_url          #=> BBC::Redux::MediaUrl
+    #   asset.ts_stripped_url #=> BBC::Redux::MediaUrl
+    #
+    # @author Matt Haynes <matt.haynes@bbc.co.uk>
+    class Asset
+
+      include Virtus.value_object
+
+      # @!attribute [r] channel
+      # @return [Channel] the asset's channel
+      attribute :channel, BBC::Redux::Channel
+
+      # @!attribute [r] description
+      # @return [String] the asset's description
+      attribute :description, String
+
+      # @!attribute [r] duration
+      # @return [Integer] the asset's duration in seconds
+      attribute :duration, Integer
+
+      # @private
+      # @!attribute [r] access_key
+      # @return [String] the asset's access key
+      attribute :access_key, String
+
+      # @!attribute [r] start
+      # @return [DateTime] the asset's start date / time. Generally schedule
+      # time
+      attribute :start,  DateTime
+
+      # @!attribute [r] reference
+      # @return [String] the asset's disk reference
+      attribute :reference, String
+
+      alias :disk_reference :reference
+
+      # @!attribute [r] name
+      # @return [String] the asset's name / title
+      attribute :name, String
+
+      alias :title :name
+
+      # @!attribute [r] uuid
+      # @return [String] the user's uuid
+      attribute :uuid, String
+
+      # @!attribute [r] key
+      # @return [Key] the asset's access key object
+      def key
+        @key ||= Key.new(access_key)
+      end
+
+      private
+
+      def self.has_media_url(type)
+        define_method(:"#{type}_url") do
+          MediaUrl.new(reference, type, key)
+        end
+      end
+
+      public
+
+      # @!macro [new] has_media_url
+      #   @!attribute [r] $1_url
+      #     @return [BBC::Redux::MediaUrl] a media url for the $1 file
+      has_media_url :dvbsubs
+
+      # @macro has_media_url
+      has_media_url :flv
+
+      # @macro has_media_url
+      has_media_url :h264_hi
+
+      # @macro has_media_url
+      has_media_url :h264_lo
+
+      # @macro has_media_url
+      has_media_url :mp3
+
+      # @macro has_media_url
+      has_media_url :ts
+
+      # @macro has_media_url
+      has_media_url :ts_stripped
+
+    end
+
+  end
+end

data/lib/bbc/redux/channel.rb

@@ -0,0 +1,45 @@
+require 'virtus'
+
+module BBC
+  module Redux
+
+    # Redux API Channel Object
+    #
+    # @example Properties of the channel object
+    #
+    #   channel = redux_client.channels.first
+    #
+    #   channel.category_id  #=> Integer
+    #   channel.display_name #=> String
+    #   channel.name         #=> String
+    #   channel.sort_order   #=> Integer
+    #
+    # @author Matt Haynes <matt.haynes@bbc.co.uk>
+    class Channel
+
+      include Virtus.value_object
+
+      # @!attribute [r] category_id
+      # @return [Integer] channel's category id
+      attribute :category_id, Integer
+
+      # @!attribute [r] display_name
+      # @return [String] channel display name, e.g. 'BBC One'
+      attribute :display_name, String
+
+      alias :longname :display_name
+
+      # @!attribute [r] name
+      # @return [String] channel short name, e.g. 'bbcone'
+      attribute :name, String
+
+      # @!attribute [r] sortorder
+      # @return [Integer] channel's suggested sort order in list views
+      attribute :sortorder, Integer
+
+      alias :sort_order :sortorder
+
+    end
+
+  end
+end