agree2 0.1.1

data/spec/party_spec.rb

@@ -0,0 +1,138 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+require 'open-uri'
+#require 'hpricot'
+require 'oauth/request_proxy/rack_request'
+require 'rack/request'
+require 'rack/mock'
+
+include Agree2
+describe Party do
+  before(:each) do
+    @client=Agree2::Client.new "client_key","client_secret"
+    @user=Agree2::User.new(@client,"token","token_secret")
+    @agreement=Agreement.new @user,{:permalink=>'hello'}
+    @json=IO.read(File.join(File.dirname(__FILE__),"fixtures","party.json"))
+  end
+  
+  describe "Create new" do
+    before(:each) do
+      @party=Party.new(@agreement,{:first_name=>"Bob",:last_name=>"Wildcat",:email=>'bob@gmail.inv'})
+    end
+    it "should be new record" do
+      @party.should be_new_record
+    end
+    
+    it "should have agreement" do
+      @party.agreement.should==@agreement
+    end
+    
+    it "should have a user" do
+      @party.user.should==@user
+    end
+    
+    it "should have first_name" do 
+      @party.first_name.should=="Bob"
+    end
+  
+    it "should have last_name" do 
+      @party.last_name.should=="Wildcat"
+    end
+    
+    describe "Save to Server" do
+      before(:each) do      
+        @user.should_receive(:post).with("/agreements/hello/parties",
+          {'party'=>{:first_name=>"Bob",:last_name=>"Wildcat",:email=>'bob@gmail.inv'}}).and_return(@json)
+      end
+      
+      it "should save and return true" do
+        @party.save
+      end
+
+      it "should no longer be new record" do
+        @party.save
+        @party.should_not be_new_record
+      end
+
+      it "should have a permalink" do
+        @party.save
+        @party.id.should==1102
+      end
+    end
+    
+  end
+
+  describe "from json" do
+
+    before(:each) do
+      @party=Party.new(@agreement,@json)
+    end
+
+    it "should have agreement" do
+      @party.agreement.should==@agreement
+    end
+    
+    it "should have a user" do
+      @party.user.should==@user
+    end
+    
+    it "should have first_name" do 
+      @party.first_name.should=="Bob"
+    end
+  
+    it "should have last_name" do 
+      @party.last_name.should=="Wildcat"
+    end
+    
+    it "should have a path" do
+      @party.path.should=="/agreements/hello/parties/1102"
+    end
+    
+    it "should have a url" do
+      @party.to_url.should=="https://agree2.com/agreements/hello/parties/1102"
+    end
+    
+    it "should generate present url" do
+      present_url=@party.present
+      present_url=~/^(http.*)\?(.*)$/
+      $1.should=="https://agree2.com/present/hello/to/bob@gmail.inv"
+    end
+    
+    it "should verify present url" do
+      present_url=@party.present
+      request = Rack::Request.new(Rack::MockRequest.env_for(present_url))
+      OAuth::Signature.verify(request,{:consumer=>@client.consumer,:token=>@user.access_token}).should==true
+      
+    end
+    
+    describe "Save to Server" do
+      before(:each) do      
+        @user.should_receive(:put).with("/agreements/hello/parties/1102",
+          {'party'=>@party.attributes}).and_return(@json)
+      end
+      
+      it "should save and return true" do
+        @party.save
+      end
+
+    end
+    
+  end
+end
+
+describe Agree2::Party, "party hash validation" do
+  before(:each) do
+    @hash={:first_name=>'Bob',:last_name=>'Wilson',:email=>'bob@gmail.com',:organization_name=>'SomeCo Inc.'}
+  end
+  
+  it "should validate" do
+    lambda {Party.validate_party_hash(@hash).should==true}.should_not raise_error
+  end
+
+  [:first_name,:last_name,:email].each do |field|
+    it "should require #{field.to_s}" do
+      @hash.delete(field)
+      lambda {Party.validate_party_hash(@hash)}.should raise_error(ArgumentError)
+    end
+  end
+
+end

data/spec/proxy_collection_spec.rb

@@ -0,0 +1,124 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+describe Agree2::ProxyCollection do
+  
+  before(:each) do
+    @client=Agree2::Client.new "client_key","client_secret"
+    @user=Agree2::User.new(@client,"token","token_secret")
+  end
+  describe "load" do
+    before(:each) do
+      @agreements=Agree2::ProxyCollection.new(@user,"/agreements")
+      @json="[#{IO.read(File.join(File.dirname(__FILE__),"fixtures","agreement.json"))}]"
+      @user.stub!(:get).and_return(@json)
+    end
+    
+    it "should have a path" do
+      @agreements.path.should=="/agreements"
+    end
+    
+    it "should have singular" do
+      @agreements.singular.should=='Agreement'
+    end
+
+    it "should call web service" do
+      @user.should_receive(:get).with("/agreements").and_return(@json)
+      @agreements.length.should==1
+    end
+
+    it "should have a user" do
+      @agreements.user.should==@user
+    end
+  end
+  
+  describe "with default value" do
+    before(:each) do
+      @agreements=Agree2::ProxyCollection.new(@user,"/agreements",nil,[{:permalink=>'hello'}])
+    end
+    
+    it "should have a path" do
+      @agreements.path.should=="/agreements"
+    end
+    
+    it "should have singular" do
+      @agreements.singular.should=='Agreement'
+    end
+
+    it "should have a user" do
+      @agreements.user.should==@user
+    end
+    
+    it "should have one item" do
+      @agreements.length.should==1
+    end
+    
+    it "should not call web service" do
+      @user.should_not_receive(:get)
+      @agreements.first      
+    end
+    
+    it "should find an individual resource" do
+      @user.should_receive(:get).with('/agreements/something').and_return(
+                      IO.read(File.join(File.dirname(__FILE__),"fixtures","agreement.json")))
+      @agreements.find('something')
+    end
+    
+    it "should instantiate a new party" do
+      Agree2::Agreement.should_receive(:new).with(@user,{:title=>"Test",:body=>"Body"})
+      @agreements.build :title=>"Test",:body=>"Body"
+    end
+    
+    it "should create and save a new party" do
+      @agreement=mock("agreement")
+      Agree2::Agreement.should_receive(:new).with(@user,{:title=>"Test",:body=>"Body"}).and_return(@agreement)
+      @agreement.should_receive(:save)
+      @agreements.create :title=>"Test",:body=>"Body"
+    end
+    
+  end
+  
+  describe "nested load" do
+    before(:each) do
+      @agreement=Agree2::Agreement.new(@user,{:permalink=>'hello'})
+      @parties=@agreement.parties
+      @json="[#{IO.read(File.join(File.dirname(__FILE__),"fixtures","party.json"))}]"
+      @user.stub!(:get).and_return(@json)
+    end
+    
+    it "should have a path" do
+      @parties.path.should=="/agreements/hello/parties"
+    end
+    
+    it "should have singular" do
+      @parties.singular.should=='Party'
+    end
+
+    it "should call web service" do
+      @user.should_receive(:get).with("/agreements/hello/parties").and_return(@json)
+      @parties.length.should==1
+    end
+
+    it "should have a user" do
+      @parties.user.should==@user
+    end
+    
+    it "should find an individual resource" do
+      @user.should_receive(:get).with('/agreements/hello/parties/123').and_return(
+                      IO.read(File.join(File.dirname(__FILE__),"fixtures","party.json")))
+      @parties.find(123)
+    end
+
+    it "should instantiate a new party" do
+      Agree2::Party.should_receive(:new).with(@agreement,{:first_name=>"Bob",:last_name=>"Galbraith",:email=>'bob@bob.inv'})
+      @parties.build :first_name=>"Bob",:last_name=>"Galbraith",:email=>'bob@bob.inv'
+    end
+    
+    it "should create and save a new party" do
+      @party=mock("party")
+      Agree2::Party.should_receive(:new).with(@agreement,{:first_name=>"Bob",:last_name=>"Galbraith",:email=>'bob@bob.inv'}).and_return(@party)
+      @party.should_receive(:save)
+      @parties.create :first_name=>"Bob",:last_name=>"Galbraith",:email=>'bob@bob.inv'
+    end    
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$:<<File.dirname(__FILE__)
+$:<<File.join(File.dirname(__FILE__),"..","lib")
+require 'agree2'
+require 'spec'
+

data/spec/template_spec.rb

@@ -0,0 +1,89 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+describe Agree2::Template do
+  before(:each) do
+    @client=Agree2::Client.new "client_key","client_secret"
+    @user=Agree2::User.new(@client,"token","token_secret")
+    @template=Agree2::Template.new(@user,{:permalink=>'hello'})
+    @fields={:amount=>100}
+    @bob={:first_name=>'Bob',:last_name=>'Green',:email=>'bob@green.inv'}
+    @json=IO.read(File.join(File.dirname(__FILE__),"fixtures","agreement.json"))
+    
+  end
+
+  it "should have a user" do
+    @template.user.should==@user
+  end
+  
+  it "should have correct path" do
+    @template.path.should=="/masters/hello"
+  end
+  
+  it "should have correct url" do
+    @template.to_url.should=="https://agree2.com/masters/hello"
+  end
+
+  describe "prepare" do
+    before(:each) do
+      @agreement=mock('agreement')
+      @user.stub!(:get).and_return(@agreement)
+    end
+    
+    it "should call raw_prepare with correct parameters" do
+      @template.should_receive(:raw_prepare).with(:fields=>@fields,:parties=>{:client=>@bob})
+      @template.prepare(@fields,{:client=>@bob})
+    end
+
+    it "should call raw_prepare with correct parameters for application" do
+      @template.should_receive(:raw_prepare).with(:fields=>@fields,:parties=>{:client=>@bob,'service'=>:application})
+      @template.prepare(@fields,{:client=>@bob},'service')
+    end
+
+    it "should call raw_prepare with correct parameters" do
+      @user.should_receive(:post).with("/masters/hello/prepare",:fields=>@fields,:parties=>{:client=>@bob}).and_return(@json)
+      @template.prepare(@fields,{:client=>@bob})
+    end
+
+    it "should raise exception and not receive raw_prepare when parties aren't valid" do
+      @bob.delete(:email)
+      @template.should_not_receive(:raw_prepare)
+      lambda {@template.prepare(@fields,{:client=>@bob})}.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe "prepare and sign" do
+    before(:each) do
+      @agreement=mock('agreement')
+      @user.stub!(:get).and_return(@agreement)
+    end
+    
+    it "should call raw_prepare with correct parameters" do
+      @template.should_receive(:raw_prepare).with(:fields=>@fields,
+                :parties=>{:client=>@bob,'application'=>:application},:sign=>'application')
+      @template.prepare_and_sign(@fields,{:client=>@bob})
+    end
+
+    it "should call raw_prepare with correct parameters for application" do
+      @template.should_receive(:raw_prepare).with(:fields=>@fields,:parties=>{:client=>@bob,'service'=>:application},:sign=>'service')
+      @template.prepare_and_sign(@fields,{:client=>@bob},'service')
+    end
+
+    it "should call raw_prepare with correct parameters" do
+      @user.should_receive(:post).with("/masters/hello/prepare",:fields=>@fields,
+                :parties=>{:client=>@bob,'application'=>:application},:sign=>'application').and_return(@json)
+      @template.prepare_and_sign(@fields,{:client=>@bob})
+    end
+
+    it "should raise exception and not receive raw_prepare when parties aren't valid" do
+      @bob.delete(:email)
+      @template.should_not_receive(:raw_prepare)
+      lambda {@template.prepare_and_sign(@fields,{:client=>@bob})}.should raise_error(ArgumentError)
+    end
+
+    it "should raise exception and not receive raw_prepare when no parties are present" do
+      @bob.delete(:email)
+      @template.should_not_receive(:raw_prepare)
+      lambda {@template.prepare_and_sign(@fields,{})}.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/user_spec.rb

@@ -0,0 +1,77 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+describe Agree2::User do
+  
+  before(:each) do
+    @client=Agree2::Client.new "client_key","client_secret"
+    @user=Agree2::User.new(@client,"token","token_secret")
+  end
+    
+  it "should create user" do
+    @user.client.should==@client
+    @user.access_token.consumer.should==@client.consumer
+    @user.token.should=="token"
+    @user.secret.should=="token_secret"
+  end
+  
+  it "should find all agreements" do
+    @agreements=[]
+    @json="[]"
+    @user.should_receive(:get).with("/agreements").and_return(@json)
+    @user.agreements.length.should==0
+    @user.agreements.should==@agreements
+  end
+  
+  it "should find all templates" do
+    @templates=[]
+    @json="[]"
+    @user.should_receive(:get).with("/masters").and_return(@json)
+    @user.templates.length.should==0
+    @user.templates.should==@templates
+  end
+  
+  describe "http calls" do
+    before(:each) do
+      @token=@user.access_token
+      @json='{"hello":"world"}'
+      @response=mock("response")
+      @response.stub!(:code).and_return("200")
+      @response.stub!(:body).and_return(@json)
+    end
+    
+    [:get,:head,:delete].each do |m|
+      it "should perform http #{m.to_s}" do
+        @token.should_receive(m).with("/test",{'Content-Type'=>'application/json','Accept'=>'application/json'}).and_return(@response)
+        @user.send(m,"/test").should==@json
+      end
+    end
+
+    [:post,:put].each do |m|
+      it "should perform http #{m.to_s} with no data" do
+        @token.should_receive(m).with("/test",nil,{'Content-Type'=>'application/json','Accept'=>'application/json'}).and_return(@response)
+        @user.send(m,"/test").should==@json
+      end
+
+      it "should perform http #{m.to_s} with hash" do
+        @token.should_receive(m).with("/test",'{"test":"this"}',{'Content-Type'=>'application/json','Accept'=>'application/json'}).and_return(@response)
+        @user.send(m,"/test",{:test=>'this'}).should==@json
+      end
+    end
+    
+    describe "handle_response" do
+      it "should return body" do
+        @user.send(:handle_response,@response).should==@json
+      end
+
+      it "should return handle redirect" do
+        @response.stub!(:code).and_return("302")
+        @response.stub!(:[]).and_return('https://agree2.com/agreements/my_agreement')
+        @user.should_receive(:get).with('/agreements/my_agreement').and_return('{"permalink":"my_agreement","title":"hello there"}')
+        @agreement=@user.send(:handle_response,@response)
+        @agreement.permalink.should=='my_agreement'
+        @agreement.title.should=='hello there'
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: agree2
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Pelle Braendgaard
+- Lau Taarnskov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+description: Agree2 Ruby client library
+email: 
+- support@agree2.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- README.rdoc
+files: 
+- History.txt
+- License.txt
+- README.rdoc
+- Rakefile
+- lib/agree2.rb
+- lib/agree2/base.rb
+- lib/agree2/client.rb
+- lib/agree2/user.rb
+- lib/agree2/agreement.rb
+- lib/agree2/party.rb
+- lib/agree2/proxy_collection.rb
+- lib/agree2/template.rb
+has_rdoc: true
+homepage: http://agree2.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: agree2
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 2
+summary: Agree2 Ruby client library
+test_files: 
+- spec/spec_helper.rb
+- spec/agreement_spec.rb
+- spec/client_spec.rb
+- spec/party_spec.rb
+- spec/proxy_collection_spec.rb
+- spec/template_spec.rb
+- spec/user_spec.rb
+- spec/fixtures/agreement.json
+- spec/fixtures/party.json