signnow 0.0.3 → 0.0.5

data/lib/signnow.rb

@@ -1,44 +1,131 @@
+# This gem is not officially provided by SignNow.com. This gem was created by Mike Simmons.
+# Official documentaion to the SignNow API is availalbe at 
+# https://signnow.atlassian.net/wiki/dashboard.action
+# Ruby implemntation of the SignNow API  
+#
+# [Important Notes:]
+#   Before you can use the SignNow API you have to recieve an API key (encoded_client_credentials) from SignNow.
+#
+#   Get Your key at http://developers.signnow.com/  
+#
+# [Example:]
+#   > require 'signnow'
+#
+#   > r = \Signnow.create_user(YOUR_ENCODED_CLIENT_CREDENTIALS, 'first', 'last', 'a1@xyz.com', 'password')
+# 
+#   <HTTParty::Response:0x7fff240525c8 parsed_response={"expires_in"=>2592000, "token_type"=>"bearer", "access_token"=>"7e36842d6d3494877f6ff0fbbb131fcf04134c6cf0d9581b9bf13f6ac4f2a69a", "refresh_token"=>"92554b4fe792313bdf604f362ca4373d8d390b00acb6cbfb949bc4b619448654", "scope"=>"*", "id"=>"05a309627dd45114c9b874f2479b4335bb010835"}, @response=#<Net::HTTPOK 200 OK readbody=true>, @headers={"date"=>["Tue, 28 May 2013 02:10:12 GMT"], "server"=>["Apache/2.2.15 (CentOS)"], "x-powered-by"=>["PHP/5.3.3"], "access-control-allow-origin"=>["*"], "access-control-allow-headers"=>["Authorization"], "content-type"=>["application/json; charset=utf-8"], "set-cookie"=>["admin=lee56sfigb3cs0fk484sr3ci26; expires=Tue, 28-May-2013 03:10:12 GMT; path=/"], "connection"=>["close"], "transfer-encoding"=>["chunked"]}> </tt>
+#
+#   > r.keys
+#   \=> ["expires_in", "token_type", "access_token", "refresh_token", "scope", "id"] 
+#
+#   > r.values
+#   \=> [2592000, "bearer", "1553698ece6e803886db1416bd043f9cd6ab79285620f3ed8f4ef1292c334745", "9bf640a692c4c1b6be34d9f28522344e8c902305e0e403ab65797d6f682f62a6", "*", "18fd5850a48b2433429c0dca832a7ed3faf604d0"] 
+# 
+#   \>> \r["access_token"]
+#
+#   \=> "7e36842d6d3494877f6ff0fbbb131fcf04134c6cf0d9581b9bf13f6ac4f2a69a"
+
+
 class Signnow
-  include   HTTMultiParty
+
+  require 'httmultiparty'
+  include HTTMultiParty
+  
   ssl_version :SSLv3
   base_uri "https://capi-eval.signnow.com/api"
-  headers "Authorization" => "Basic MGZjY2RiYzczNTgxY2EwZjliZjhjMzc5ZTZhOTY4MTM6MzcxOWExMjRiY2ZjMDNjNTM0ZDRmNWMwNWI1YTE5NmI="
-    
-  def initialize ()  
-  end
 
-  def self.request_token (user_email, password)
-    response = post("/oauth2/token", :body =>"username=#{user_email}&password=#{password}&grant_type=password")
+  # creates a new user by ENCODED_CLIENT_CREDENTIALS
+  # (encoded_client_credentials, first_name, last_name, email, password='basicpass')
+  # --- if no password is specified "basicpass" will be used
+  
+  def self.create_user(encoded_client_credentials, first_name, last_name, email, password='basicpass')
+    self.headers "Authorization" => "Basic " + encoded_client_credentials
+    response = post("/user", :body => "{\"first_name\":\"#{first_name}\",\"last_name\":\"#{last_name}\",\"email\":\"#{email}\",\"password\":\"#{password}\"}")
     return response
   end
   
-  def self.get_file_list(access_credential, options={})
-    self.headers "Authorization" => "Bearer " + access_credential        
-    response = get("/user/documentsv2")
+  # creates a new user by an access_token
+  # (access_token, first_name, last_name, email, password='basicpass')
+  # --- if no password is specified "basicpass" will be used
+
+  def self.create_referenced_user (access_token, first_name, last_name, email, password='basicpass')
+    #creates a new user by an access_token
+    self.headers "Authorization" => "Bearer " + access_token  
+    response = post("/user", :body => "{\"first_name\":\"#{first_name}\",\"last_name\":\"#{last_name}\",\"email\":\"#{email}\",\"password\":\"#{password}\"}")
     return response
   end
   
-  def self.create_user_account (access_credential, email, password, first_name, last_name)
-    self.headers "Authorization" => "Bearer " + access_credential  
-    response = post("/user", :body => "{\"first_name\":\"#{first_name}\",\"last_name\":\"#{last_name}\",\"email\":\"#{email}\",\"password\":\"#{password}\"}")
+  # Request an access token for a user
+  # (encoded_client_credentials, user_email, password)
+  def self.request_token (encoded_client_credentials, user_email, password)
+    self.headers "Authorization" => "Basic " + encoded_client_credentials
+    response = post("/oauth2/token", :body =>"username=#{user_email}&password=#{password}&grant_type=password")
+    return response
+  end
+
+  # Verify an access token for a user
+  # (access_token)
+  def self.verify_token(access_token)
+    self.headers "Authorization" => "Bearer " + access_token
+    response = get('/oauth2/token')
     return response
   end
 
-  def self.create_document (access_credential, file)  
-    self.headers "Authorization" => "Bearer " + access_credential
+  # Retrieve a user resource
+  # (access_token)
+  def self.retrieve_user(access_token)
+    self.headers "Authorization" => "Bearer " + access_token
+    response = get('/user')  
+    return response
+  end    
+  
+  # Uploads a file
+  # (access_token, file)  
+  def self.create_document (access_token, file)  
+    self.headers "Authorization" => "Bearer " + access_token
     response = post("/document", :body => {:file => File.new(file)})
     return response
   end
 
-  def self.find_user (access_credential)
-    self.headers "Authorization" => "Bearer " + access_credential
-    response = get("/user")
+
+  # Retrieve a list of the user’s documents
+  # (access_token)
+  def self.get_file_list(access_token)
+    self.headers "Authorization" => "Bearer " + access_token        
+    response = get("/user/documentsv2")
     return response
   end
-  def self.invite_signer(access_credential, from_email, to_email, document_id)
-    self.headers "Authorization" => "Bearer " + access_credential
+  
+  #  Retrieve a document resource
+  #  (access_token, document_id)
+  def self.get_document(access_token, document_id)
+    self.headers "Authorization" => "Bearer " + access_token
+    response = get("/document/#{document_id}")
+  end
+  
+  # Download a document
+  # (access_token, document_id)
+  def self.download_document(access_token, document_id)
+    self.headers "Authorization" => "Bearer " + access_token
+    response = get("/document/#{document_id}/download?type=collapsed")
+    return response
+  end
+  
+  # Create an invite to sign a document
+  # (access_token, from_email, to_email, document_id)
+  def self.invite_signer(access_token, from_email, to_email, document_id)
+    self.headers "Authorization" => "Bearer " + access_token
     response = post("/document/#{document_id}/invite", :body => "{\"from\":\"#{from_email}\",\"to\":\"#{to_email}\"}")
     return response
   end
     
+  # Create a notary invite to sign a document
+  # (access_token, from_email, to_email, document_id, originator_pay=true)
+    
+  def self.invite_notary(access_token, from_email, to_email, document_id, originator_pay=true)
+    self.headers "Authorization" => "Bearer " + access_token
+    response = post("/notaryinvite", :body => "{\"from\":\"#{from_email}\",\"to\":\"#{to_email}\",\"document_id\":\"#{document_id}\",\"originator_pay\":#{originator_pay}}") 
+  return response
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signnow
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.3.10
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.10
 description: A ruby implementation of the signnow API
 email: nearmars@gmail.com
 executables: []