agree2 0.1.1

data/lib/agree2/proxy_collection.rb

@@ -0,0 +1,76 @@
+require 'json'
+module Agree2
+  class ProxyCollection
+    alias_method :proxy_respond_to?, :respond_to? #:nodoc:
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_)/ }
+    attr_accessor :user,:path,:singular
+    def initialize(container,path,class_name=nil,values=nil)
+      @container=container
+      @user=(container.is_a?(User) ? container : container.user)
+      @path=path
+      path=~/(\w+)$/
+      @singular=(class_name||$1.singularize).downcase.classify
+      @klass=eval "Agree2::#{@singular}"
+      if values
+        @target=instantiate_items(values)
+      else
+        reset
+      end
+    end
+    
+    # Builds an instance of the record
+    def build(attributes={})
+      @klass.new @container,attributes
+    end
+    
+    # Builds and saves and instance of the record
+    def create(attributes={})
+      build(attributes).save
+    end
+    
+    # Finds the instance given the id
+    def find(id)
+      @klass.get @container,id
+    end
+    
+    def respond_to?(symbol, include_priv = false) #:nodoc:
+      proxy_respond_to?(symbol, include_priv) || (load_target && @target.respond_to?(symbol, include_priv))
+    end
+    
+    # Explicitly proxy === because the instance method removal above
+    # doesn't catch it.
+    def ===(other) #:nodoc:
+      load_target
+      other === @target
+    end
+    
+    protected
+    
+    def parse_json(json) #:nodoc:
+      instantiate_items(JSON.parse(json))
+    end
+    
+    def instantiate_items(list=[]) #:nodoc:
+      list.collect{|e|instantiate_item(e)}
+    end
+    
+    def instantiate_item(attributes={}) #:nodoc:
+      @klass.new @container,attributes
+    end
+        
+    def load_target #:nodoc:
+      @target||=parse_json(@user.get("#{self.path}"))
+    end
+    
+    def reset #:nodoc:
+      @target=nil
+    end
+    
+    def method_missing(method, *args, &block) #:nodoc:
+      if load_target
+        @target.send(method, *args, &block)
+      end
+    end
+    
+  end
+end

data/lib/agree2/template.rb

@@ -0,0 +1,100 @@
+module Agree2
+  # The Template allows you to create agreements based on a template. You can pick between existing community created templates or
+  # create your own that fits your application.
+  #
+  # To review some of the public templates available go to: https://agree2.com/masters/public
+  #
+  # If you plan on creating and signing an agreement for your user to accept the process is like this:
+  #
+  # 1. Load your template
+  # 2. Prepare and Sign the agreement, which fills out the template, invites your user and signs it on your behalf
+  # 3. Redirect the User to Accept
+  # 4. User Accepts agreement
+  # 5. Agree2 optional calls an "endpoint" web service on your web service.
+  # 6. User is redirected back to your application to a URL you designate
+  #
+  class Template<Agreement
+    
+    def self.collection_name  #:nodoc:
+      "masters"
+    end
+        
+    # Prepares a template and optionally invites parties.
+    #
+    # === optional fields
+    #
+    # <tt>fields</tt> - a hash of parameters to be used to fill out the template. eg:
+    #
+    #     {:amount=>100,:valid_to=>1.month.from_now,:service=>'Ruby Developer'}
+    # 
+    # <tt>parties</tt> - a hash of parties. The hash should follow this format:
+    #
+    #     { :client=>{:first_name=>'Bob',:last_name=>'Bryson',:email=>'bob@bob.inv',:organization_name=>'Big Client Inc'}}
+    # 
+    # The above adds a party with the role *client*. The first_name, last_name and email fields are all required.
+    #
+    # <tt>application_role</tt> if you would like to add your applications user as a party set this to the role that you want:
+    #
+    #     @template.prepare {},{},"broker"
+    #
+    # Adds your application as a party with the role broker.
+    #
+    # A typical example for a consulting agreement:
+    #
+    #     @template.prepare {:rate=>"140",:valid_to=>"1 month from today"},
+    #                           {
+    #                             :consultant=>{:first_name=>'Alice',:last_name=>'Springs',:email=>'alice@example.com'},
+    #                             :client=>{:first_name=>'Bob',:last_name=>'Bryson',:email=>'bob@bob.inv',
+    #                                       :organization_name=>'Big Client Inc'}
+    #                           }
+    #     }
+    #
+    def prepare(fields={},parties={},application_role=nil)
+      Party.validate_parties_hash(parties)
+      parties[application_role]=:application if application_role
+      raw_prepare(:fields=>fields,:parties=>parties)
+    end
+    
+    # Prepares a template, invites parties and signs it with your application
+    #
+    # === required fields
+    #
+    # <tt>fields</tt> - a hash of parameters to be used to fill out the template. eg:
+    #
+    #     {:amount=>100,:valid_to=>1.month.from_now,:service=>'Ruby Developer'}
+    # 
+    # <tt>parties</tt> - a hash of parties. The hash should follow this format:
+    #
+    #     { :client=>{:first_name=>'Bob',:last_name=>'Bryson',:email=>'bob@bob.inv',:organization_name=>'Big Client Inc'}}
+    # 
+    # The above adds a party with the role *client*. The first_name, last_name and email fields are all required.
+    #
+    # <tt>application_role</tt> if you would like to add your applications user as a party set this to the role that you want:
+    #
+    #     @template.prepare_and_sign {},{},"broker"
+    #
+    # Adds your application as a party with the role broker.
+    #
+    # A typical example for a user agreement:
+    #
+    #     @template.prepare_and_sign {:name=>"Alice Springs"},
+    #                           {
+    #                             :user=>{:first_name=>'Alice',:last_name=>'Springs',:email=>'alice@example.com'}
+    #                           },'service'
+    #     }
+    #
+    
+    def prepare_and_sign(fields={},parties={},application_role='application')
+      raise ArgumentError,"You need to add at least one party" if parties.empty?
+      Party.validate_parties_hash(parties)
+      parties[application_role]=:application
+      raw_prepare(:fields=>fields,:parties=>parties,:sign=>application_role)
+    end
+    
+    protected
+
+    def raw_prepare(params={}) #:nodoc:
+      Agreement.new @user, user.post("/masters/#{permalink}/prepare",params)
+    end
+  end
+end

data/lib/agree2/user.rb

@@ -0,0 +1,73 @@
+AGREE2_JSON_HEADERS={'Content-Type'=>'application/json','Accept'=>'application/json'}
+module Agree2
+  class User
+    attr_accessor :client,:access_token
+    def initialize(client,key,secret)
+      @client=client
+      @access_token=OAuth::AccessToken.new @client.consumer,key,secret
+    end
+    
+    def agreements
+      @agreements||=Agree2::ProxyCollection.new self,'/agreements','Agreement'
+    end
+    
+    def templates
+      @templates||=Agree2::ProxyCollection.new self,'/masters','Template'
+    end
+    
+    def get(path)
+      handle_response @access_token.get(path,AGREE2_JSON_HEADERS)
+    end
+
+    def head(path)
+      handle_response @access_token.head(path,AGREE2_JSON_HEADERS)
+    end
+    
+    def post(path,data=nil)
+      handle_response @access_token.post(path,(data ? data.to_json : nil),AGREE2_JSON_HEADERS)
+    end
+    
+    def put(path,data=nil)
+      handle_response @access_token.put(path,(data ? data.to_json : nil),AGREE2_JSON_HEADERS )
+    end
+    
+    def delete(path)
+      handle_response @access_token.delete(path,AGREE2_JSON_HEADERS)
+    end
+
+    # OAuth Stuff below here
+    
+    # The AccessToken token
+    def token
+      @access_token.token
+    end
+    
+    # The AccessToken secret
+    def secret
+      @access_token.secret
+    end
+    
+    def path #:nodoc:
+      ""
+    end
+    protected
+    
+    def handle_response(response)#:nodoc:
+      case response.code
+      when "200"
+        response.body
+      when "201"
+        response.body
+      when "302"
+        if response['Location']=~/(#{AGREE2_URL})\/(.*)$/
+          parts=$2.split('/')
+          (('Agree2::'+parts[0].classify).constantize).get self,parts[1]
+        else
+          #todo raise hell
+        end
+      else
+        response
+      end
+    end
+  end
+end

data/lib/agree2.rb

@@ -0,0 +1,34 @@
+require 'net/https'
+require 'rubygems'
+gem 'oauth', ">= 0.2.4"
+require 'oauth'
+gem 'json'
+gem 'activesupport'
+require 'activesupport'
+AGREE2_ENV = :production unless defined?(AGREE2_ENV)
+AGREE2_URL = (AGREE2_ENV==:development) ? 'http://agree2.dev' : 'https://agree2.com'
+module Agree2
+  class Agree2Exception < RuntimeError #:nodoc:
+  end
+end
+require 'agree2/client'
+require 'agree2/proxy_collection'
+require 'agree2/user'
+require 'agree2/base'
+require 'agree2/agreement'
+require 'agree2/party'
+require 'agree2/template'
+
+
+
+# FireEagle addition to the <code>OAuth::Consumer</code> class. Taken from Yahoo FireEagle GEM
+class OAuth::Consumer
+  alias_method :create_http_with_verify, :create_http
+  # Monkey patch to silence the SSL warnings
+  def create_http_without_verify #:nodoc:
+    http_object             = create_http_with_verify
+    http_object.verify_mode = OpenSSL::SSL::VERIFY_NONE if uri.scheme=="https"
+    http_object
+  end
+  alias_method :create_http, :create_http_without_verify
+end

data/spec/agreement_spec.rb

@@ -0,0 +1,190 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+describe Agree2::Agreement do
+  before(:each) do
+    @client=Agree2::Client.new "client_key","client_secret"
+    @user=Agree2::User.new(@client,"token","token_secret")
+    @json=IO.read(File.join(File.dirname(__FILE__),"fixtures","agreement.json"))
+  end
+  
+  describe "Built from hash" do
+    before(:each) do
+      @agreement=Agree2::Agreement.new(@user,{:title=>"My Title",:body=>"My Body"})
+    end
+    
+    it "should have attribute hash" do
+      @agreement.attributes.should=={:title=>"My Title",:body=>"My Body"}
+    end
+    
+    it "should have a user" do
+      @agreement.user.should==@user
+    end
+  
+    it "should have title" do 
+      @agreement.title.should=="My Title"
+    end
+  
+    it "should have body" do
+      @agreement.body.should=="My Body"
+    end
+    
+    it "should be new record" do
+      @agreement.should be_new_record
+    end
+    
+    describe "Save to Server" do
+      before(:each) do
+        @user.should_receive(:post).with("/agreements",{'agreement'=>{:title=>"My Title",:body=>"My Body"}}).and_return(@json)
+      end
+      
+      it "should save and return true" do
+        @agreement.save
+      end
+
+      it "should no longer be new record" do
+        @agreement.save
+        @agreement.should_not be_new_record
+      end
+
+      it "should have a permalink" do
+        @agreement.save
+        @agreement.permalink.should_not be_nil
+      end
+    end
+  end
+
+  describe "from json" do
+
+    before(:each) do
+      @agreement=Agree2::Agreement.new(@user,@json)
+    end
+
+    it "should have a user" do
+      @agreement.user.should==@user
+    end
+
+    it "should have title" do
+      @agreement.title.should=="Agreement to pay [currency=USD] [amount=100] to [recipient]"
+    end
+
+    it "should have permalink" do
+      @agreement.permalink.should=="hello"
+    end
+
+    it "should have a nil body" do
+      @agreement.body.should be_nil
+    end
+    
+    it "should have a path" do
+      @agreement.path.should=="/agreements/hello"
+    end
+    
+    it "should have a url" do
+      @agreement.to_url.should=="https://agree2.com/agreements/hello"
+    end
+        
+    [:created_at,:updated_at,:fields,:state,:active_version,:version,
+      :digest,:finalized_at,:finalized_at,:terminated_at,:activated_at,:valid_to].each do |field|
+          it "should have #{field}" do
+            @agreement.send(field).should_not be_nil
+          end
+    end
+    
+    it "should have fields" do
+      @agreement.fields.should=={
+        "amount"=> "100",
+        "currency"=> "USD"
+      }
+    end
+    
+    it "should have methods defined for fields" do
+      @agreement.amount.should=="100"
+      @agreement.currency.should=="USD"
+    end
+    [:amount,:currency].each do |field|
+      it "should support setting the value" do
+        @agreement.send("#{field.to_s}=".to_sym,"test this")
+        @agreement.send(field).should=="test this"
+        @agreement.fields[field.to_s].should=="test this"
+      end
+      
+      it "should have respond_to wired for field accessor" do
+        @agreement.respond_to?(field).should==true
+      end
+      
+      it "should have respond_to wired for field setter" do
+        @agreement.respond_to?("#{field.to_s}=".to_sym).should==true
+      end
+    end
+    
+    it "should not be new record" do
+      @agreement.should_not be_new_record
+    end
+    
+    it "should reload" do
+      @user.should_receive(:get).with("/agreements/hello").and_return(@json)
+      @agreement.reload
+    end
+
+    it "should destroy" do
+      @user.should_receive(:delete).with("/agreements/hello").and_return("")
+      @agreement.destroy
+    end
+    
+    it "should finalize" do
+      @user.should_receive(:post).with("/agreements/hello/finalize").and_return(" ")
+      @agreement.finalize!.should==true
+    end
+    
+    describe "Save to Server" do
+      before(:each) do
+        @user.should_receive(:put).with("/agreements/hello",{"fields"=>@agreement.fields}).and_return(@json)
+      end
+      
+      it "should save and return true" do
+        @agreement.save
+      end
+
+      it "should not a be new record" do
+        @agreement.save
+        @agreement.should_not be_new_record
+      end
+
+      it "should have a permalink" do
+        @agreement.save
+        @agreement.permalink.should_not be_nil
+      end
+    end
+  end
+
+  describe "load from server" do
+    before(:each) do
+      @user.should_receive(:get).with("/agreements/hello").and_return(@json)
+    end
+
+    def do_get
+      @agreement=Agree2::Agreement.get(@user,"hello")
+    end
+
+    it "should have a user" do
+      do_get
+      @agreement.user.should==@user
+    end
+
+    it "should have title" do
+      do_get
+      @agreement.title.should=="Agreement to pay [currency=USD] [amount=100] to [recipient]"
+    end
+
+    it "should have permalink" do
+      do_get
+      @agreement.permalink.should=="hello"
+    end
+    
+    it "should not be new record" do
+      do_get
+      @agreement.should_not be_new_record
+    end
+    
+  end
+end
+

data/spec/client_spec.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+describe Agree2::Client do
+  
+  before(:each) do
+    @client=Agree2::Client.new "client_key","client_secret"
+  end
+  
+  it "should contain key and secret" do
+    @client.key.should=="client_key"
+    @client.secret.should=="client_secret"
+  end
+  
+  it "should have consumer" do
+    consumer=@client.consumer
+    consumer.key.should==@client.key
+    consumer.secret.should==@client.secret
+    consumer.site.should=="https://agree2.com"
+  end
+  
+  it "should create user" do
+    user=@client.user("token","token_secret")
+    user.client.should==@client
+    user.access_token.consumer.should==@client.consumer
+    user.token.should=="token"
+    user.secret.should=="token_secret"
+  end
+  
+  it "should create request token" do
+    request_token=mock("access_token")
+    @client.consumer.should_receive(:get_request_token).and_return(request_token)
+    token=@client.get_request_token
+    token.should==request_token
+  end
+
+  it "should create request token" do
+    request_token=mock("request_token")
+    access_token=mock("access_token")
+    access_token.stub!(:token).and_return('token')
+    access_token.stub!(:secret).and_return('token_secret')
+    request_token.should_receive(:get_access_token).and_return(access_token)
+    user=@client.user_from_request_token(request_token)
+    user.client.should==@client
+    user.access_token.consumer.should==@client.consumer
+    user.token.should=="token"
+    user.secret.should=="token_secret"
+  end
+
+end

data/spec/fixtures/agreement.json

@@ -0,0 +1,50 @@
+{
+   "permalink": "hello",
+   "valid_to": "2009/08/12 22:04:51 +0000",
+   "updated_at": "2008/08/12 22:04:51 +0000",
+   "activated_at": "2008/08/12 22:04:51 +0000",
+   "parties": [
+     {
+       "updated_at": "2008/08/12 22:04:51 +0000",
+       "invited_by_id": null,
+       "account_id": null,
+       "role": "client",
+       "organization_name": null,
+       "invited_at": null,
+       "id": 1102,
+       "agreement_id": 757,
+       "user_id": null,
+       "first_name": "Bob",
+       "accept_code": "d373b3dc17b7177aa0626e6ce7f449fcc3ca7c9c",
+       "last_name": "Wildcat",
+       "email": "bob@gmail.inv",
+       "created_at": "2008/08/12 22:04:51 +0000"},
+     {
+       "updated_at": "2008/08/12 22:04:51 +0000",
+       "invited_by_id": null,
+       "account_id": 1,
+       "role": "provider",
+       "organization_name": null,
+       "invited_at": null,
+       "id": 1103,
+       "agreement_id": 757,
+       "user_id": 1,
+       "first_name": "Pelle",
+       "accept_code": "39e6c8c02e8ee9efb7a3606a45b3e297ce616b55",
+       "last_name": "Braendgaard",
+       "email": "pelle@stakeventures.com",
+       "created_at": "2008/08/12 22:04:51 +0000"}
+   ],
+   "title": "Agreement to pay [currency=USD] [amount=100] to [recipient]",
+   "active_version": 1,
+   "smart_fields": {
+     "amount": "100",
+     "currency": "USD"
+    },
+   "terminated_at": "2008/08/12 22:04:51 +0000",
+   "digest": "70b2d46022ae44ea8041c7573e856a14b2186273",
+   "finalized_at": "2008/08/12 22:04:51 +0000",
+   "version": 1,
+   "description": "An agreement",
+   "state": "final",
+   "created_at": "2008/08/12 22:04:51 +0000"}

data/spec/fixtures/party.json

@@ -0,0 +1,15 @@
+{
+  "updated_at": "2008/08/12 22:04:51 +0000",
+  "invited_by_id": null,
+  "account_id": null,
+  "role": "client",
+  "organization_name": null,
+  "invited_at": null,
+  "id": 1102,
+  "agreement_id": 757,
+  "user_id": null,
+  "first_name": "Bob",
+  "last_name": "Wildcat",
+  "email": "bob@gmail.inv",
+  "created_at": "2008/08/12 22:04:51 +0000"
+}