inkdit 1.0.0 → 1.1.0

data/lib/inkdit.rb

@@ -61,4 +61,22 @@ module Inkdit
 
   # an exception that's raised when a request fails due to an invalid access token
   class Unauthorized < Exception; end
+
+  # a generic exception raised when an request fails for any other reason
+  class Error < Exception
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super()
+    end
+
+    def message
+      "response.status=#{response.status} response.body=#{response.body.inspect}"
+    end
+
+    def inspect
+      "#<#{self.class.inspect} #{self.message}>"
+    end
+  end
 end

data/lib/inkdit/client.rb

@@ -74,7 +74,9 @@ module Inkdit
     # raises {Inkdit::Unauthorized} if the response indicates an invalid access token.
     # @return [OAuth2::Response]
     def checked_response(response)
-      if response.status == 401 and response.headers['www-authenticate'].match /invalid_token/
+      if response.status == 401 and
+        response.headers['www-authenticate'] and
+        response.headers['www-authenticate'].match /invalid_token/
         # wrong access token or the user rescinded the app's access.
         # TODO: properly parse the header
         # Bearer realm="api.inkdit.com", error="invalid_token"

data/lib/inkdit/contract.rb

@@ -12,6 +12,8 @@ module Inkdit
     # @return [Contract] contract the newly created contract
     def self.create(client, owner, params)
       response = client.post owner.contracts_link, { :body => params.to_json, :headers => { 'Content-Type' => 'application/json' } }
+      raise Inkdit::Error.new(response) unless response.status == 201
+
       self.new(client, response.parsed)
     end
 
@@ -55,8 +57,8 @@ module Inkdit
       end
     end
 
-    # @param [Entity] individual the individual who should be connected to the contract
-    # @param [Entity] entity     the entity that the individual should be connected to the contract through
+    # @param [String] individual the url of an individual who should be connected to the contract
+    # @param [String] entity     the url of an entity that the individual should be connected to the contract through
     def share_with(individual, entity)
       params = {
         :individual => {

data/lib/inkdit/entity.rb

@@ -25,6 +25,8 @@ module Inkdit
     # @return [Array<Contract>] the contracts in this entity's Contract Collection
     def get_contracts
       response = @client.get(contracts_link)
+      raise Inkdit::Error.new(response) unless response.status == 200
+
       response.parsed['resources'].map do |contract_params|
         Contract.new @client, contract_params
       end

data/lib/inkdit/signature.rb

@@ -13,7 +13,9 @@ module Inkdit
 
     # @return [Entity] the entity this field was signed on behalf of
     def on_behalf_of
-      Inkdit::Entity.new(@client, @params['on_behalf_of'])
+      if @params['on_behalf_of']
+        Inkdit::Entity.new(@client, @params['on_behalf_of'])
+      end
     end
 
     # @return [Time] when this field was signed

data/lib/inkdit/signature_field.rb

@@ -12,6 +12,10 @@ module Inkdit
       @params['url']
     end
 
+    def designation_url
+      @params['links']['designation']
+    end
+
     # sign this field as the user and entity associated with the current access token.
     # @return [Signature] the newly-created signature
     def sign!
@@ -21,9 +25,41 @@ module Inkdit
 
       response = @client.put self.url, { :body => params.to_json, :headers => { 'Content-Type' => 'application/json' } }
 
+      if response.status != 201
+        raise Inkdit::Error.new(response)
+      end
+
       Inkdit::Signature.new(@client, response.parsed)
     end
 
+    # +params+ is a Hash specifying who this signature field should be
+    # designated to.
+    # It must contain the key +individual+.
+    # It can contain the key +organization+ if a specific organization
+    # is being designated.
+    #
+    # , and +organization+. At least one
+    # should be present. They should be [Entity]s
+    def designate(params)
+      params = {
+        :individual => { :url => params[:individual].url }
+      }
+
+      params[:entity] = if params[:organization]
+                          { :url => params[:organization].url }
+                        else
+                          params[:individual]
+                        end
+
+      response = @client.put self.designation_url, { :body => params.to_json, :headers => { 'Content-Type' => 'application/json' } }
+
+      if response.status != 200
+        raise Inkdit::Error.new(response)
+      end
+
+      Inkdit::SignatureField.new(@client, @contract, response.parsed)
+    end
+
     def inspect
       "#<#{self.class.inspect} params=#{@params}>"
     end

data/lib/inkdit/version.rb

@@ -1,3 +1,3 @@
 module Inkdit
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/script/get_access_token.rb

@@ -35,6 +35,15 @@ get '/get-auth-code' do
 end
 
 get '/got-auth-code' do
+  if params[:error]
+    return <<END
+    <p>Uh-oh, we ran into a problem!</p>
+
+    <p>Error: <code>#{params[:error]}</code></p>
+    <p>Description: #{params[:error_description]}</p>
+END
+  end
+
   auth_code = params[:code]
 
   @access_token = Inkdit.get_token(params[:code], url('/got-auth-code'))

data/spec/contract_spec.rb

@@ -40,11 +40,35 @@ describe Inkdit::Contract do
     contract.signatures.length.should == 1
     signature_field = contract.signatures.first
 
+    designated_line = signature_field.designate :individual => entity
+
     signature = signature_field.sign!
 
-    signature.signed_by.should    == entity
-    signature.on_behalf_of.should == entity
+    signature.signed_by.should == entity
+
+    if entity.type == 'individual'
+      signature.on_behalf_of.should be_nil
+    else
+      signature.on_behalf_of.should == entity
+    end
   end
 
-  pending 'sharing a contract (this is tough to do because it requires an entity URL)'
+  pending 'allows you to share a contract (this is tough to do because it requires an entity URL)' do
+    entity = @client.get_entity
+
+    contract_name = "API Test #{Time.now.iso8601}"
+
+    params = {
+      :name    => contract_name,
+      :content => "I agree etc. etc. etc.\n##signature##",
+      :test    => true
+    }
+
+    contract = Inkdit::Contract.create @client, entity, params
+
+    # this shouldn't actually return a response but whatevs.
+    response = contract.share_with(SOME_OTHER_USER, SOME_OTHER_USER)
+
+    response.status.should == 201
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inkdit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-10 00:00:00.000000000 Z
+date: 2012-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &14778920 !ruby/object:Gem::Requirement
+  requirement: &21202900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14778920
+  version_requirements: *21202900
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &14778260 !ruby/object:Gem::Requirement
+  requirement: &21200800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14778260
+  version_requirements: *21200800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14777780 !ruby/object:Gem::Requirement
+  requirement: &20798500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14777780
+  version_requirements: *20798500
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &14627380 !ruby/object:Gem::Requirement
+  requirement: &20793340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14627380
+  version_requirements: *20793340
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &14625260 !ruby/object:Gem::Requirement
+  requirement: &20819320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14625260
+  version_requirements: *20819320
 description: ! 'A library for using the Inkdit API to sign, share and store contracts.