bbc_redux 0.4.3.pre → 0.4.4.pre

data/README.md

@@ -112,6 +112,9 @@ to message us.
 
     # Search 
 
+    # You can also search on these params, see docs for more details
+    # :q, :name, :channel, :before, :after, :date, :longer, :shorter,
+    # :programme_crid, :series_crid,
     results = client.search(:name => 'Pingu')
     
     results.created_at     #=> DateTime
@@ -154,6 +157,28 @@ http://rubydoc.info/github/bbcsnippets/redux-client-ruby/version-4/frames
 
 ## Caveats / Known Issues
 
+### Number of HTTP requests
+
+All the methods on the `BBC::Redux::Client` object represent a HTTP request to
+the API, caching is left as an exercise to the reader.
+
+This means you should at the very least be careful with how you handle the
+returned objects. This code for example makes four HTTP requests:
+
+    client.asset('5966413090093319525').channel
+    client.asset('5966413090093319525').description
+    client.asset('5966413090093319525').name
+    client.asset('5966413090093319525').reference
+
+Where as this code makes only one:
+
+    asset = client.asset('5966413090093319525')
+    
+    asset.channel
+    asset.description
+    asset.name
+    asset.reference
+
 ### Using a proxy server
 
 The client uses [Typhoeus](https://github.com/dbalatero/typhoeus) which

data/lib/bbc/redux/client.rb

@@ -32,6 +32,10 @@ module BBC
     # @author Matt Haynes <matt.haynes@bbc.co.uk>
     class Client
 
+      # Raised when you try to login and you account has been marked as
+      # compromised
+      class AccountCompromisedException < Exception; end
+
       # Raised when backend HTTP API returns a 403, indicates you are either
       # trying to access some content that is unavailable to you, or your token
       # and session has expired.
@@ -67,6 +71,13 @@ module BBC
       # @option options [Object] :http (Typhoeus) The http client, can be
       #   overidden but expects method .post to return an object looking like
       #   Typhoeus::Response (code, headers, body, etc)
+      #
+      # @raise [ArgumentError] if you provide neither :username / :password nor
+      #   :token keys
+      # @raise [AccountCompromisedException] if the account has been flagged as
+      #   compromised
+      # @raise [ForbiddenException] if your username or password are incorrect
+      # @raise [HttpException] if backend fails
       def initialize(options = {})
         @host  = options[:host] || 'https://i.bbcredux.com'
         @http  = options[:http] || Typhoeus
@@ -79,9 +90,14 @@ module BBC
               :username => username, :password => password
             })
 
+            if data['compromised']
+              raise AccountCompromisedException
+            end
+
             @token = data.fetch('token')
           else
-            raise 'Supply either :token or :username and :password options'
+            err = 'Supply either :token or :username and :password options'
+            raise ArgumentError.new(err)
           end
         end
       end
@@ -216,6 +232,17 @@ module BBC
         build :user, :using => data_for(:user)
       end
 
+      # @return [Boolean] true if other_clinet is a redux client with the same
+      #   token, host and http
+      def ==(other_client)
+        self.class == other_client.class && \
+        self.token == other_client.token && \
+        self.host  == other_client.host  && \
+        self.http  == other_client.http
+      end
+
+      alias :eql? :==
+
       private
 
       # @private

data/lib/bbc/redux/cookie.rb

@@ -0,0 +1,91 @@
+module BBC
+  module Redux
+
+    # Redux Cookie util class
+    #
+    # A utility class for creating and parsing correct Redux cookies. Can be
+    # constructed from an existing client object or a raw cookie string
+    #
+    # @example Build cookie from client
+    #
+    #   client = BBC::Redux::Client.new({
+    #     :username => 'username',
+    #     :password => 'password',
+    #   })
+    #
+    #   cookie = BBC::Redux::Cookie.new(client)
+    #
+    #   cookie.token  #=> String
+    #   cookie.client #=> BBC::Redux::Client
+    #   cookie.to_s   #=> String
+    #
+    # @example Build cookie from existing value
+    #
+    #   string = "BBC_video=some-token; domain=.bbcredux.com; path=/"
+    #
+    #   cookie = BBC::Redux::Cookie.new(string)
+    #
+    #   cookie.token  #=> String
+    #   cookie.client #=> BBC::Redux::Client
+    #   cookie.to_s   #=> String
+    #
+    # @author Matt Haynes <matt.haynes@bbc.co.uk>
+    class Cookie
+
+      # @!attribute [r] token
+      # @return [String] session token
+      attr_reader :token
+
+      # @!attribute [r] string
+      # @return [String] string representation of cookie, for use in HTTP
+      #   responses Set-Cookie header
+      attr_reader :string
+
+      alias :to_s :string
+
+      # @!attribute [r] client
+      # @return [BBC::Redux::Client] client object built from token
+      attr_reader :client
+
+      # Build cookie from eith a client object or string value (the literal
+      # value of a prior HTTP cookie)
+      #
+      # @param [String|BBC::Redux::Client] value value to build cookie from
+      # @raise [ArgumentError] cookie string format incorrect, or non client
+      #   object given
+      def initialize(value)
+        if value.class == BBC::Redux::Client
+          @token  = value.token
+          @client = value
+          @string = build_string(token)
+        elsif value.class == String
+          if value =~ /BBC_video=(.*);\s+domain=.bbcredux.com;\s+path=\//
+            @token  = $1
+            @client = BBC::Redux::Client.new( :token => token )
+            @string = build_string(token)
+          else
+            raise ArgumentError.new('bad cookie format')
+          end
+        else
+          raise ArgumentError.new('provide BBC::Redux::Client or String')
+        end
+      end
+
+      # @return [Boolean] true if other_cookie is a redux cookie with the same
+      #   token
+      def ==(other_cookie)
+        self.class == other_cookie.class && self.token == other_cookie.token
+      end
+
+      alias :eql? :==
+
+      private
+
+      def build_string(token)
+        "BBC_video=#{token}; domain=.bbcredux.com; path=/"
+      end
+
+    end
+
+  end
+end

data/lib/bbc/redux/version.rb

@@ -2,7 +2,7 @@ module BBC
   module Redux
 
     # Library version
-    VERSION = '0.4.3.pre'
+    VERSION = '0.4.4.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/cookie'
 require_relative 'redux/crid'
 require_relative 'redux/end_points'
 require_relative 'redux/key'

data/spec/bbc/redux/client_spec.rb

@@ -72,9 +72,28 @@ describe BBC::Redux::Client do
     end
   end
 
+  context 'account is compromised' do
+
+    subject do
+      described_class.new({
+        :http => http_client, :username => 'foo', :password => 'bar'
+      })
+    end
+
+    it 'raises error' do
+
+      resp = double(:resp, :code => 200, :body => '{"compromised": true}')
+
+      expect(http_client).to receive(:post).and_return(resp)
+
+      expect { subject }.to \
+        raise_error(BBC::Redux::Client::AccountCompromisedException)
+    end
+  end
+
   context 'initialized with neither token or username / password' do
     it 'raises an error' do
-      expect { described_class.new }.to raise_error
+      expect { described_class.new }.to raise_error(ArgumentError)
     end
   end
 

data/spec/bbc/redux/cookie_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe BBC::Redux::Cookie do
+
+  let(:token)  { '1111111-Yf9hnrYmSsmCcWVZ52rquLRoaeDJT9EA'         }
+  let(:string) { "BBC_video=#{token}; domain=.bbcredux.com; path=/" }
+  let(:client) { BBC::Redux::Client.new( :token => token )          }
+
+  context 'initialized with string' do
+    subject { described_class.new(string) }
+    its('token')  { should eq(token)  }
+    its('client') { should eq(client) }
+    its('to_s')   { should eq(string) }
+    its('string') { should eq(string) }
+
+    context 'bad string' do
+      it 'should raise error' do
+        expect { described_class.new('foobar') }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  context 'initialized with client' do
+    subject { described_class.new(client) }
+    its('client') { should eq(client) }
+    its('token')  { should eq(token)  }
+    its('to_s')   { should eq(string) }
+    its('string') { should eq(string) }
+  end
+
+  context 'initialized with junk' do
+    it 'should raise error' do
+      expect { described_class.new(1234) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '.==' do
+    it 'should be true when token is the same' do
+      a = described_class.new(string)
+      b = described_class.new(client)
+      expect(a).to eq(b)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bbc_redux
 version: !ruby/object:Gem::Version
-  version: 0.4.3.pre
+  version: 0.4.4.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-28 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/cookie.rb
 - lib/bbc/redux/crid.rb
 - lib/bbc/redux/end_points.rb
 - lib/bbc/redux/key.rb
@@ -172,6 +173,7 @@ files:
 - spec/bbc/redux/channel_category_spec.rb
 - spec/bbc/redux/channel_spec.rb
 - spec/bbc/redux/client_spec.rb
+- spec/bbc/redux/cookie_spec.rb
 - spec/bbc/redux/key_spec.rb
 - spec/bbc/redux/media_url_spec.rb
 - spec/bbc/redux/search_results_spec.rb
@@ -198,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1134618896184121202
+      hash: 4200921616866606374
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -217,6 +219,7 @@ test_files:
 - spec/bbc/redux/channel_category_spec.rb
 - spec/bbc/redux/channel_spec.rb
 - spec/bbc/redux/client_spec.rb
+- spec/bbc/redux/cookie_spec.rb
 - spec/bbc/redux/key_spec.rb
 - spec/bbc/redux/media_url_spec.rb
 - spec/bbc/redux/search_results_spec.rb