borneo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d64c1413e46a3e1e5469512e43277708ec8ea5e
-  data.tar.gz: 1ad40d090b75e9f7db82f190278b65e711763156
+  metadata.gz: cfe703be7f73d5c997eeb801e0e4d4c17dc92c23
+  data.tar.gz: 04731283ad3ef4c40d0e9ebe18de0e11873c85bf
 SHA512:
-  metadata.gz: 60759f17c9efa3376562ecaac6293ff58e56b2a3007cd5b51aa26424599db990fedebc420914f4065b65bf7b130d9dad0568db1781b2a3c63933472454e235d6
-  data.tar.gz: 01a76bdf0b4422b56d650674fcbce00883ab6182a882f241808b33fa59d0168ec21d340e8a4d875b676610cd3d774b4dfa5b82e5e25e8d7561c31e6108024e68
+  metadata.gz: fee1d042eacd9c9331e6e7b826cf74d8551e02ac42ac9365b94047d1b22ecaf76fb54bda04bc812c30da712cac1bec69481ecc6cf738a5ca781a5909131d6313
+  data.tar.gz: 36e34278b5471fdc491266363633bddba72164d0a9c322c9e03a0716d782d9e9803f7bdb660d86248c5643c038b13c6a48e49a1507a2b8d1b1848b78f62328bb

data/README.md

@@ -48,6 +48,28 @@ The objects returned from the methods behave like normal Ruby objects:
 Borneo raises an error if the operation wasn't permitted. If the access token is
 stale, the library will try to refresh it once before raising an error.
 
+## Mocking
+
+To help test these services, you can switch the library into 'mocking mode' by:
+
+    Borneo::Client.enable_mocking!
+
+Before each test, you may want to clear the existing mock returns by calling:
+
+    Borneo::Client.reset_mocks!
+
+If you are using RSpec, both of these can be done by adding the following to your `spec_helper.rb`:
+
+    require 'borneo/rspec'
+
+Declaring a simple mock response can then be done as follows:
+
+    Borneo::Client.stub_service('plus', 'v1').activities.list.to_return {:items => [ ... ]}
+
+Using the RSpec helpers, this may also be simplified to:
+
+    stub_service('plus', 'v1').activities.list.to_return {:items => [ ... ]}
+
 ## Contributing
 
 1. Fork it

data/lib/borneo.rb

@@ -3,6 +3,7 @@ require "borneo/client"
 require "borneo/authorized_proxy"
 require "borneo/service"
 require "borneo/method_proxy"
+require "borneo/mock"
 
 module Borneo
   # Your code goes here...

data/lib/borneo/client.rb

@@ -2,20 +2,47 @@ require 'google/api_client'
 
 class Borneo::Client
 
-  attr_reader :client_id, :client_secret, :redirect_url
+  @@should_mock_requests = false
 
-  def initialize(client_id, client_secret, redirect_url)
+  attr_reader :client_id, :client_secret, :redirect_url, :application_name, :application_version
+
+  def self.enable_mocking!
+    @@should_mock_requests = true
+    @@service_stubs = {}
+  end
+
+  def self.disable_mocking!
+    @@should_mock_requests = false
+  end
+
+  def self.reset_mocks!
+    @@service_stubs = {}
+  end
+
+  def self.stub_service(service_name, service_version)
+    @@service_stubs[[service_name, service_version]] ||= Borneo::Mock::Service.new(self, service_name, service_version)
+  end
+
+  def initialize(client_id, client_secret, redirect_url, application_name = "Borneo Application", application_version = "0.0.1")
     @client_id = client_id
     @client_secret = client_secret
     @redirect_url = redirect_url
+    @google_client = nil
+    @application_name = application_name
+    @application_version = application_version
   end
 
   def for(access_token, refresh_token)
+    google_client.authorization.clear_credentials!
     Borneo::AuthorizedProxy.new(self,access_token, refresh_token)
   end
 
   def google_client
-    Google::APIClient.new
+    @google_client ||= Google::APIClient.new(:application_name => @application_name, :application_version => @application_version)
+  end
+
+  def mocking_requests?
+    !!@@should_mock_requests
   end
 
 end

data/lib/borneo/method_proxy.rb

@@ -12,21 +12,29 @@ class Borneo::MethodProxy
     @_components << name
   end
 
+  def mocking_enabled?
+    @_service.proxy.client.mocking_requests?
+  end
+
   def call(params = {})
-    method_call = lambda do
-      _client.execute(
-        :api_method => _method,
-        :authorization => _authorization,
-        :parameters => params
-      )
-    end
-    response = method_call.call()
-    if response.status == Borneo::ResponseStatus::STALE_ACCESS_TOKEN
-      _client.authorization.fetch_access_token!
+    unless mocking_enabled?
+      method_call = lambda do
+        _client.execute(
+          :api_method => _method,
+          :authorization => _authorization,
+          :parameters => params
+        )
+      end
       response = method_call.call()
-    end
+      if response.status == Borneo::ResponseStatus::STALE_ACCESS_TOKEN
+        _client.authorization.fetch_access_token!
+        response = method_call.call()
+      end
 
-    data = response.data
+      data = response.data
+    else
+      data = mock_service.mock_response(@_components)
+    end
 
     data
 
@@ -48,6 +56,10 @@ class Borneo::MethodProxy
     m
   end
 
+  def mock_service
+    Borneo::Client.stub_service(@_service.name, @_service.version)
+  end
+
   def method_missing(name)
     Borneo::MethodProxy.new(@_service, name, @_components)
   end

data/lib/borneo/mock.rb

@@ -0,0 +1,6 @@
+module Borneo::Mock
+  # More code here
+end
+
+require "borneo/mock/service"
+require "borneo/mock/api"

data/lib/borneo/mock/api.rb

@@ -0,0 +1,9 @@
+module Borneo::Mock::API
+
+  extend self
+
+  def stub_service(name, version)
+    Borneo::Client.stub_service(name, version)
+  end
+
+end

data/lib/borneo/mock/service.rb

@@ -0,0 +1,34 @@
+class Borneo::Mock::Service
+
+  attr :client, :name, :version
+
+  def initialize(client, name, version)
+    @client = client
+    @name = name
+    @version = version
+    @methods = {}
+    @response_data = nil
+  end
+
+  def to_return(result)
+    @response_data = result
+  end
+
+  def mock_response(components)
+    if components.count == 0
+      @response_data
+    else
+      next_proxy = @methods[components[0]]
+      unless next_proxy.nil?
+        next_proxy.mock_response(components.drop(1))
+      else
+        raise "Request not stubbed for #{components}"
+      end
+    end
+  end
+
+  def method_missing(method_name)
+    @methods[method_name] ||= Borneo::Mock::Service.new(@client, @name, @version)
+  end
+
+end

data/lib/borneo/rspec.rb

@@ -0,0 +1,17 @@
+require 'borneo'
+
+require 'rspec/core'
+
+RSpec.configure do |config|
+
+  config.include Borneo::Mock::API
+
+  config.before(:each) do
+    Borneo::Client.enable_mocking!
+  end
+
+  config.after(:each) do
+    Borneo::Client.reset_mocks!
+  end
+
+end

data/lib/borneo/version.rb

@@ -1,3 +1,3 @@
 module Borneo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/core/client_spec.rb

@@ -5,6 +5,8 @@ describe Borneo::Client do
   let(:client_id) { "SOME_CLIENT_ID" }
   let(:client_secret) { "SOME_CLIENT_SECRET" }
   let(:redirect_url) { "http://localhost" }
+  let(:app_name) { "SomeApplication" }
+  let(:app_version) { "1.0.1" }
 
   describe "initialiser" do
     it "takes a client ID, client secret and redirect URL parameters" do
@@ -13,6 +15,17 @@ describe Borneo::Client do
       client.client_secret.should == client_secret
       client.redirect_url.should == redirect_url
     end
+
+    it "optionally takes an application name and version" do
+      client = Borneo::Client.new(client_id, client_secret, redirect_url, app_name, app_version)
+      client.application_name.should == app_name
+      client.application_version.should == app_version
+    end
+  end
+
+  it "should cache the Google client value" do
+    client = Borneo::Client.new(client_id, client_secret, redirect_url)
+    client.google_client.should == client.google_client
   end
 
   describe "for" do
@@ -43,4 +56,32 @@ describe Borneo::Client do
 
   end
 
+  describe "mocking" do
+    let(:client) { Borneo::Client.new(client_id, client_secret, redirect_url) }
+
+    it "defaults to not mocking" do
+      client.should_not be_mocking_requests
+    end
+
+    it "can be set globally to use a mock rather than calling external services" do
+      Borneo::Client.enable_mocking!
+      client.should be_mocking_requests
+    end
+
+    it "can be set globally to disable mocking" do
+      Borneo::Client.enable_mocking!
+      client.should be_mocking_requests
+      Borneo::Client.disable_mocking!
+      client.should_not be_mocking_requests
+    end
+
+    describe "stub_service" do
+      it "should return a mock service" do
+        Borneo::Client.stub_service('plus', 'v1').should be_a(Borneo::Mock::Service)
+      end
+    end
+
+  end
+
+
 end

data/spec/mock/service_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + "/../spec_helper.rb"
+
+describe Borneo::Mock::Service do
+
+  let(:client_id) { "SOME_CLIENT_ID" }
+  let(:client_secret) { "SOME_CLIENT_SECRET" }
+  let(:redirect_url) { "http://localhost" }
+  let(:client) { Borneo::Client.new(client_id, client_secret, redirect_url) }
+  let(:service_name) { "oauth2" }
+  let(:service_version) { "v2" }
+
+  describe "initializer" do
+    it "should take the client, service name and service version as parameters" do
+      service = Borneo::Mock::Service.new(client, service_name, service_version)
+      service.client.should == client
+      service.name.should == service_name
+      service.version.should == service_version
+    end
+  end
+
+  describe "stubbed responses" do
+    let(:client_id) { "SOME_CLIENT_ID" }
+    let(:client_secret) { "SOME_CLIENT_SECRET" }
+    let(:redirect_url) { "http://localhost" }
+    let(:client) { Borneo::Client.new(client_id, client_secret, redirect_url) }
+    let(:access_token) { "ACCESS_TOKEN" }
+    let(:refresh_token) { "REFRESH_TOKEN" }
+    let(:service_name) { "oauth2" }
+    let(:service_version) { "v2" }
+    let(:service) { Borneo::Mock::Service.new(client, service_name, service_version) }
+    let(:stubbed_response) { { :id => "0000", :email => "jsmith@example.com" } }
+
+    it "allows simple responses to be stubbed" do
+      service.userinfo.should respond_to(:to_return)
+    end
+
+    it "returns stubbed response when query is made" do
+      Borneo::Client.enable_mocking!
+      Borneo::Client.stub_service(service_name, service_version).userinfo.to_return stubbed_response
+      client.for(access_token, refresh_token).service(service_name, service_version).userinfo.call.should == stubbed_response
+    end
+
+    it "raises an error when mocks aren't defined" do
+      Borneo::Client.enable_mocking!
+      lambda { client.for(access_token, refresh_token).service(service_name, service_version).userinfo.call }.should raise_exception(RuntimeError)
+    end
+
+    it "raises an error when mocks are reset" do
+      Borneo::Client.enable_mocking!
+      Borneo::Client.stub_service(service_name, service_version).userinfo.to_return stubbed_response
+      Borneo::Client.reset_mocks!
+      lambda { client.for(access_token, refresh_token).service(service_name, service_version).userinfo.call }.should raise_exception(RuntimeError)
+    end
+  end
+ 
+  describe "methods" do
+    let(:service) { Borneo::Mock::Service.new(client, service_name, service_version) }
+
+    it "should return another mock service for anything else" do
+      service.userinfo.should be_a(Borneo::Mock::Service)
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: borneo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joe Geldart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-10 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -125,6 +125,10 @@ files:
 - lib/borneo/authorized_proxy.rb
 - lib/borneo/client.rb
 - lib/borneo/method_proxy.rb
+- lib/borneo/mock.rb
+- lib/borneo/mock/api.rb
+- lib/borneo/mock/service.rb
+- lib/borneo/rspec.rb
 - lib/borneo/service.rb
 - lib/borneo/version.rb
 - spec/core/authorized_proxy_spec.rb
@@ -132,6 +136,7 @@ files:
 - spec/core/method_proxy_spec.rb
 - spec/core/service_spec.rb
 - spec/discovery_document.json
+- spec/mock/service_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 homepage: ''
@@ -165,5 +170,6 @@ test_files:
 - spec/core/method_proxy_spec.rb
 - spec/core/service_spec.rb
 - spec/discovery_document.json
+- spec/mock/service_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb