hellosign-ruby-sdk 3.0.0

data/lib/hello_sign/configuration.rb

@@ -0,0 +1,56 @@
+module HelloSign
+
+
+  #
+  # Define config attributes and default values for HelloSign module
+  #
+  # @author [hellosign]
+  #
+  module Configuration
+    DEFAULT_ENDPOINT = 'https://api.hellosign.com'
+    DEFAULT_API_VERSION = '/v3'
+    DEFAULT_OAUTH_ENDPOINT = "https://www.hellosign.com"
+    VALID_OPTIONS_KEYS = [:end_point, :oauth_end_point, :api_version, :user_agent, :client_id, :client_secret, :email_address, :password, :api_key, :auth_token, :log_level, :logging]
+
+
+    DEFAULT_USER_AGENT = "hellosign-ruby-sdk #{HelloSign::VERSION}"
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    #
+    # @param base [Object] new module or class extend thid module
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Resets all configuration options to the defaults.
+    def reset
+      self.email_address = nil
+      self.client_id = nil
+      self.client_secret = nil
+      self.auth_token = nil
+      self.password = nil
+      self.api_key = nil
+      self.end_point = DEFAULT_ENDPOINT
+      self.oauth_end_point = DEFAULT_OAUTH_ENDPOINT
+      self.api_version = DEFAULT_API_VERSION
+      self.user_agent = DEFAULT_USER_AGENT
+      self.log_level = 3
+      self.logging = true
+    end
+  end
+end

data/lib/hello_sign/error.rb

@@ -0,0 +1,48 @@
+module HelloSign
+  module Error
+    # Custom error class for rescuing from all HelloSign errors.
+    class Error < StandardError; end
+
+    # Raise when attributes are missing.
+    class MissingAttributes < Error; end
+
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error; end
+
+    # Raised when impossible to parse response body.
+    class Parsing < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 400.
+    class BadRequest < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 410.
+    class Gone < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class NotSupportedType < Error; end
+  end
+end

data/lib/hello_sign/resource.rb

@@ -0,0 +1,8 @@
+require 'hello_sign/resource/base_resource'
+require 'hello_sign/resource/resource_array'
+require 'hello_sign/resource/account'
+require 'hello_sign/resource/embedded'
+require 'hello_sign/resource/template'
+require 'hello_sign/resource/signature_request'
+require 'hello_sign/resource/team'
+require 'hello_sign/resource/unclaimed_draft'

data/lib/hello_sign/resource/account.rb

@@ -0,0 +1,24 @@
+module HelloSign
+  module Resource
+
+    #
+    # Contains information about an account and its settings.
+    # Take a look at our {https://www.hellosign.com/api/reference#Account account resource document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    class Account < BaseResource
+
+      #
+      # Create a new Account from a hash. If key defined then account data with be the value of hash[key], otherwise the hash itself
+      # @param  hash [Hash] account's data
+      # @param  key [String] (account) key of the hash, point to where account data is. If nil then the hash itself
+      #
+      # @return [HelloSign::Resource:Account] a Account resource
+      def initialize(hash, key='account')
+        super
+      end
+    end
+  end
+end

data/lib/hello_sign/resource/base_resource.rb

@@ -0,0 +1,60 @@
+module HelloSign
+  module Resource
+
+    #
+    # Store the value of a hash. Use missing_method to create method to access it like an object
+    #
+    # @author [hellosign]
+    #
+    class BaseResource
+
+
+      #
+      # recursively convert hash data into BaseResource.
+      #
+      # @param  hash [Hash] data of the resource
+      # @param  key [String] (nil) key of the hash, point to where resource data is. If nil then the hash itself
+      #
+      # @return [HelloSign::Resource::BaseResource] a new BaseResource
+      def initialize(hash, key=nil)
+        @raw_data = key ? hash[key] : hash
+        @data = @raw_data.inject({}) do |data, (key,value)|
+          data[key.to_s] = if value.is_a? Hash
+            value = BaseResource.new(value)
+          elsif ((value.is_a? Array) && (value[0].is_a? Hash))
+            value = value.map {|v| BaseResource.new(v)}
+          else
+            value
+          end
+          data
+        end
+      end
+
+
+      #
+      # Magic method, give class dynamic methods based on hash keys.
+      #
+      # If initialized hash has a key which matches the method name, return value of that key.
+      #
+      # Otherwise, return nil
+      #
+      # @param method [Symbol] Method's name
+      #
+      # @example
+      #   resource  = BaseResource.new :email_address => "me@example.com"
+      #   resource.email_address # =>  "me@example.com"
+      #   resource.not_in_hash_keys # => nil
+      def method_missing(method)
+        @data.key?(method.to_s) ? @data[method.to_s] : nil
+      end
+
+      #
+      # raw response data from the server in json
+      #
+      # @return [type] [description]
+      def data
+        @raw_data
+      end
+    end
+  end
+end

data/lib/hello_sign/resource/embedded.rb

@@ -0,0 +1,24 @@
+module HelloSign
+  module Resource
+
+    #
+    # An object that contains necessary information to set up embedded signing.
+    # Take a look at our {https://www.hellosign.com/api/reference#Embedded account resource document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    class Embedded < BaseResource
+
+      #
+      # create a new Embedded resource from a hash. If a key is defined then embedded data with be the value of hash[key], otherwise the hash itself
+      # @param  hash [Hash] embedded's data
+      # @param  key [String] (embedded) key of the hash, point to where embedded data is. If nil then the hash itself
+      #
+      # @return [HelloSign::Resource:Embedded] a Embedded resource
+      def initialize(hash, key='embedded')
+        super
+      end
+    end
+  end
+end

data/lib/hello_sign/resource/resource_array.rb

@@ -0,0 +1,33 @@
+require 'pry'
+module HelloSign
+  module Resource
+
+    #
+    # Stores an array of HelloSign BaseResource with paging information
+    #
+    # @author [hellosign]
+    #
+    class ResourceArray < Array
+      attr_reader :page, :num_pages, :num_results, :page_size
+
+
+      #
+      # create a new ResourceArray from a hash
+      #
+      # @param  hash [Hash] data of the array
+      # @param  key [String] key of the hash, point to where resource array data is
+      # @param  resource_class [Class] a Resource Class object inherited from BaseResource. Use the created array item from hash[key]
+      #
+      # @return [type] [description]
+      def initialize(hash, key, resource_class)
+        @page = hash['list_info']['page']
+        @num_pages = hash['list_info']['num_pages']
+        @num_results = hash['list_info']['num_results']
+        @page_size = hash['list_info']['page_size']
+        hash[key] && hash[key].each do |resouce|
+            self << resource_class.new(resouce, nil)
+          end
+      end
+    end
+  end
+end

data/lib/hello_sign/resource/signature_request.rb

@@ -0,0 +1,25 @@
+module HelloSign
+  module Resource
+
+    #
+    # Contains information regarding documents that need to be signed
+    # Take a look at our {https://www.hellosign.com/api/reference#SignatureRequest signature request resource document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    class SignatureRequest < BaseResource
+
+      #
+      # create a new SignatureRequest from a hash. If a key is defined then account data with be the value of hash[key], otherwise the hash itself
+      # @param  hash [Hash] signature request's data
+      # @param  key [String] (signature_request) key of the hash, point to where signature request data is. If nil then the hash itself
+      #
+      #
+      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest resource
+      def initialize(hash, key='signature_request')
+        super
+      end
+    end
+  end
+end

data/lib/hello_sign/resource/team.rb

@@ -0,0 +1,24 @@
+module HelloSign
+  module Resource
+
+    #
+    # Contains information about an team and its members.
+    # Take a look at our {https://www.hellosign.com/api/reference#Team team resource document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    class Team < BaseResource
+
+      #
+      # create a new Team from a hash. If a key is defined then team data with be the value of hash[key], otherwise the hash itself
+      # @param  hash [Hash] team's data
+      # @param  key [String] (team) key of the hash, point to where team data is. If nil then the hash itself
+      #
+      # @return [HelloSign::Resource:Team] a Team resource
+      def initialize(hash, key='team')
+        super
+      end
+    end
+  end
+end

data/lib/hello_sign/resource/template.rb

@@ -0,0 +1,25 @@
+module HelloSign
+  module Resource
+
+    #
+    # Contains information about the templates you and your team have created
+    #
+    # Take a look at our {https://www.hellosign.com/api/reference#Template Template resource document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    class Template < BaseResource
+
+      #
+      # create a new Template from a hash. If a key is defined then template data will be the value of hash[key], otherwise the hash itself
+      # @param  hash [Hash] template's data
+      # @param  key [String] (template) key of the hash, point to where template data is. If nil then the hash itself
+      #
+      # @return [HelloSign::Resource:Team] a Team resource
+      def initialize(hash, key='template')
+        super
+      end
+    end
+  end
+end

data/lib/hello_sign/resource/unclaimed_draft.rb

@@ -0,0 +1,25 @@
+module HelloSign
+  module Resource
+
+    #
+    # A group of documents that a user can take ownership of by going to the claim URL
+    # Take a look at our {https://www.hellosign.com/api/reference#UnclaimedDraft unclaimed draft resource document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    class UnclaimedDraft < BaseResource
+
+      #
+      # create a new UnclaimedDraft from a hash. If a key is defined then unclaimed draft data with be the value of hash[key], otherwise the hash itself
+      # @param  hash [Hash] unclaimed draft's data
+      # @param  key [String] (unclaimed_draft) key of the hash, point to where unclaimed draft data is. If nil then the hash itself
+      #
+      # @return [HelloSign::Resource:Team] a Team resource
+      def initialize(hash, key='unclaimed_draft')
+        super
+      end
+    end
+
+  end
+end

data/lib/hello_sign/version.rb

@@ -0,0 +1,3 @@
+module HelloSign
+  VERSION = "3.0.0"
+end

data/spec/fixtures/account.json

@@ -0,0 +1 @@
+{"account": {"account_id":"123456789", "email_address":"test@example.com", "is_paid_hs":false, "is_paid_hf":false, "quotas":{"templates_left":0, "documents_left":0, "api_signature_requests_left":0}, "callback_url":"https://example.com", "role_code":""}}

data/spec/fixtures/embedded.json

@@ -0,0 +1,6 @@
+{
+    "embedded": {
+        "sign_url": "https://api.hellosign.com/editor/embeddedSign?signature_id=50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b&token=b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
+        "expires_at": 1396469502
+    }
+}

data/spec/fixtures/error.json

@@ -0,0 +1,6 @@
+{
+  "error": {
+      "error_msg": "Error Message",
+      "error_name": "Error Name"
+  }
+}

data/spec/fixtures/signature_request.json

@@ -0,0 +1,2 @@
+{"signature_request":{"signature_request_id":"1", "title":"title", "original_title":"original_title", "subject":"subject", "message":"message", "test_mode":false, "is_complete":true, "has_error":false, "custom_fields":[],
+  "response_data":[{"name":"name", "value":"value", "type":"signature", "api_id":"api_id", "signature_id":"signature_id"}], "signing_url":"https://example.com/signing_url", "signing_redirect_url":"https://example.com/signing_redirect_url", "final_copy_uri":"/v3/final_copy_url", "files_url":"https://example.com/file_url", "details_url":"https://example.com/details_url", "requester_email_address":"requester_email_address@example.com", "signatures":[{"signature_id":"signature_id", "has_pin":false, "signer_email_address":"signer_email_address@example.com", "signer_name":"signer_name", "order":1, "status_code":"signed", "signed_at":1393389891, "last_viewed_at":1393389853, "last_reminded_at":1393389852}], "cc_email_addresses":[]}}

data/spec/fixtures/signature_requests.json

@@ -0,0 +1,14 @@
+{
+  "list_info": {
+		"page": 1,
+		"num_pages": 1,
+		"num_results": 1,
+		"page_size": 20
+	},
+  "signature_requests":[
+    {
+      "signature_request_id":"1", "title":"title", "original_title":"original_title", "subject":"subject", "message":"message", "test_mode":false, "is_complete":true, "has_error":false, "custom_fields":[],
+      "response_data":[{"name":"name", "value":"value", "type":"signature", "api_id":"api_id", "signature_id":"signature_id"}], "signing_url":"https://example.com/signing_url", "signing_redirect_url":"https://example.com/signing_redirect_url", "final_copy_uri":"/v3/final_copy_url", "files_url":"https://example.com/file_url", "details_url":"https://example.com/details_url", "requester_email_address":"requester_email_address@example.com", "signatures":[{"signature_id":"signature_id", "has_pin":false, "signer_email_address":"signer_email_address@example.com", "signer_name":"signer_name", "order":1, "status_code":"signed", "signed_at":1393389891, "last_viewed_at":1393389853, "last_reminded_at":1393389852}], "cc_email_addresses":[]
+    }
+  ]
+}

data/spec/fixtures/team.json

@@ -0,0 +1,19 @@
+{
+  "team": {
+    "name": "Team HelloSign",
+    "accounts": [
+      {
+        "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
+        "email_address": "me@example.com",
+        "role_code": "a"
+      },
+      {
+        "account_id": "d3d3d7b98d80b67d07740df7cdfd1f49fa8e2b82",
+        "email_address": "teammate@example.com",
+        "role_code": "m"
+      }
+    ],
+    "invited_accounts": [
+    ]
+  }
+}

data/spec/fixtures/template.json

@@ -0,0 +1 @@
+{"template":{"template_id":"a364138e0d8ae6393aa425a8ec64715580f3748b","title":"bitcoin","message":"Hello, bitcoin pdf here","is_creator":true,"can_edit":true,"signer_roles":[{"name":"Client","order":null}],"cc_roles":[],"documents":[{"index":"0","name":"bitcoin.pdf","custom_fields":[],"form_fields":[{"name":"","type":"signature","signer":"1","x":501,"y":7498,"width":120,"height":30,"required":true,"api_id":"a1ca72_9"}]}],"custom_fields":[],"named_form_fields":[{"name":"","type":"signature","signer":"1","x":501,"y":7498,"width":120,"height":30,"required":true,"api_id":"a1ca72_9"}],"accounts":[{"account_id":"a82bbf8a2fb928f239e2bd59df50e23b82b3eedd","email_address":"testuser@example.com","is_paid_hs":false,"is_paid_hf":false,"quotas":{"templates_left":0,"documents_left":3,"api_signature_requests_left":0}}]}}

data/spec/fixtures/templates.json

@@ -0,0 +1,11 @@
+{
+  "list_info": {
+    "page": 1,
+    "num_pages": 1,
+    "num_results": 1,
+    "page_size": 20
+  },
+  "templates":[
+    {"template_id":"a364138e0d8ae6393aa425a8ec64715580f3748b","title":"bitcoin","message":"Hello, bitcoin pdf here","is_creator":true,"can_edit":true,"signer_roles":[{"name":"Client","order":null}],"cc_roles":[],"documents":[{"index":"0","name":"bitcoin.pdf","custom_fields":[],"form_fields":[{"name":"","type":"signature","signer":"1","x":501,"y":7498,"width":120,"height":30,"required":true,"api_id":"a1ca72_9"}]}],"custom_fields":[],"named_form_fields":[{"name":"","type":"signature","signer":"1","x":501,"y":7498,"width":120,"height":30,"required":true,"api_id":"a1ca72_9"}],"accounts":[{"account_id":"a82bbf8a2fb928f239e2bd59df50e23b82b3eedd","email_address":"testuser@example.com","is_paid_hs":false,"is_paid_hf":false,"quotas":{"templates_left":0,"documents_left":3,"api_signature_requests_left":0}}]}
+  ]
+}