signnow-ruby 0.0.2

data/lib/signnow/request/connection.rb

@@ -0,0 +1,74 @@
+module Signnow
+  module Request
+    class Connection
+      include Helpers
+      attr_reader :https
+
+      def initialize(request_info)
+        @info = request_info
+      end
+
+      def setup_https
+        @https             = Net::HTTP.new(api_url, Net::HTTP.https_default_port)
+        @https.use_ssl     = true
+        @https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      def request
+        https.start do |connection|
+          https.request(https_request)
+        end
+      end
+
+      protected
+
+      def authentication
+        return {} unless @info.authentication[:type]
+        case @info.authentication[:type]
+        when :basic
+          raise AuthenticationError unless Signnow.encoded_app_credentials
+          {'Authorization' => "Basic #{Signnow.encoded_app_credentials}"}
+        when :user_token
+          raise AuthenticationError unless @info.authentication[:token]
+          {'Authorization' => "Bearer #{@info.authentication[:token]}"}
+        else
+          {}
+        end
+      end
+
+      def https_request
+        https_request = case @info.http_method
+                        when :post
+                          Net::HTTP::Post.new(@info.url, authentication)
+                        when :put
+                          Net::HTTP::Put.new(@info.url, authentication)
+                        when :delete
+                          Net::HTTP::Delete.new(@info.url, authentication)
+                        else
+                          Net::HTTP::Get.new(@info.path_with_params(@info.url, @info.data), authentication)
+                        end
+
+        if [:post, :put].include?(@info.http_method)
+          if @info.use_form_data?
+            https_request.set_form_data(@info.data)
+          else
+            https_request.body = JSON.generate(normalize_params(@info.data))
+          end
+        end
+
+        https_request
+      end
+
+      # Returns the api url foir this request or default
+      def api_url
+        domain + '.' + API_BASE
+      end
+
+      # Returns the domain for the current request or the default one
+      def domain
+        return @info.subdomain if @info
+        DOMAIN_BASE
+      end
+    end
+  end
+end

data/lib/signnow/request/helpers.rb

@@ -0,0 +1,36 @@
+module Signnow
+  module Request
+    module Helpers
+      def flatten_hash_keys(old_hash, new_hash={}, keys=nil)
+        old_hash.each do |key, value|
+          key = key.to_s
+          if value.is_a?(Hash)
+            all_keys_formatted = keys + "[#{key}]"
+            flatten_hash_keys(value, new_hash, all_keys_formatted)
+          else
+            new_hash[key] = value
+          end
+        end
+        new_hash
+      end
+
+      def normalize_params(params, key=nil)
+        params = flatten_hash_keys(params) if params.is_a?(Hash)
+        result = {}
+        params.each do |key, value|
+          case value
+          when Hash
+            result[key.to_s] = normalize_params(value)
+          when Array
+            value.each_with_index do |item_value, index|
+              result["#{key.to_s}[#{index}]"] = item_value.to_s
+            end
+          else
+            result[key.to_s] = value.to_s
+          end
+        end
+        result
+      end
+    end
+  end
+end

data/lib/signnow/request/info.rb

@@ -0,0 +1,50 @@
+module Signnow
+  module Request
+    class Info
+      attr_accessor :http_method, :api_url, :data, :subdomain, :authentication, :base_path, :options
+
+      def initialize(http_method, subdomain, api_url, data, options={})
+        @http_method = http_method
+        @subdomain   = subdomain || Signnow.domain
+        @api_url     = api_url
+        @data        = data
+        @base_path   = Signnow.base_path
+        @authentication = {}
+        @authentication[:type] = options.delete(:auth_type)
+        @authentication[:token] = options.delete(:auth_token)
+        @options = options
+      end
+
+      def url
+        url = ''
+        url += "/#{base_path}" if base_path
+        url += "/#{api_url}"
+        if has_id?
+          url += "/#{data[:id]}"
+          data.delete(:id)
+        end
+
+        url
+      end
+
+      def path_with_params(path, params)
+        unless params.empty?
+          encoded_params = URI.encode_www_form(params)
+          [path, encoded_params].join("?")
+        else
+          path
+        end
+      end
+
+      def use_form_data?
+        options.fetch(:use_form_data, false)
+      end
+
+      protected
+
+      def has_id?
+        !data[:id].nil?
+      end
+    end
+  end
+end

data/lib/signnow/request/validator.rb

@@ -0,0 +1,52 @@
+module Signnow
+  module Request
+    class Validator
+      attr_reader :info
+      attr_accessor :response
+
+      def initialize(info)
+        @info = info
+      end
+
+      def validated_data_for(incoming_response)
+        self.response = incoming_response
+        verify_response_code
+        info.data = JSON.parse(response.body)
+        validate_response_data
+        info.data
+      end
+
+      protected
+
+      def verify_response_code
+        raise AuthenticationError if response.code.to_i == 401
+        raise NotFound if response.code.to_i == 404
+        raise APIError if response.code.to_i >= 500
+      end
+
+      def validate_response_data(body=nil)
+        body ||= info.data
+        if body.is_a?(Hash)
+          if body['404']
+            fail NotFound.new(body['404'])
+          elsif body['error']
+            handle_api_error(body['code'], body['error'])
+          elsif body['errors']
+            body['errors'].each do |error|
+              handle_api_error(error['code'], error['message'])
+            end
+          end
+        end
+      end
+
+      def handle_api_error(code, message)
+        error = case code
+                when 1539  then InvalidToken.new(message)
+                when 65536 then EmptyDocuments.new(message)
+                else            APIError.new(message)
+                end
+        fail error
+      end
+    end
+  end
+end

data/lib/signnow/user.rb

@@ -0,0 +1,31 @@
+module Signnow
+  class User < Base
+    include Signnow::Operations::Show
+
+    attr_accessor :id, :email, :first_name, :last_name, :attributes, :active,
+      :type, :pro, :created, :emails, :identity, :subscriptions, :credits,
+      :has_atticus_access, :is_logged_in, :teams
+
+    # Initializes the object using the given attributes
+    #
+    # @param [Hash] attributes The attributes to use for initialization
+    def initialize(attributes = {})
+      super(attributes)
+      parse_booleans
+    end
+
+    def email
+      return @email if @email
+      return unless emails
+      emails.first
+    end
+
+    # Parses Boolean fileds.
+    def parse_booleans
+      @active = ( active == '1' ) if active and active.is_a? String
+      @pro = ( pro == 1 ) if pro and pro.is_a? Integer
+    end
+    protected :parse_booleans
+
+  end
+end

data/lib/signnow/version.rb

@@ -0,0 +1,3 @@
+module Signnow
+  VERSION = '0.0.2'
+end

data/signnow.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "signnow/version"
+
+Gem::Specification.new do |s|
+  s.name        = "signnow-ruby"
+  s.version     = Signnow::VERSION
+  s.authors     = ["Andres Bravo"]
+  s.email       = ["hola@andresbravo.com"]
+  s.homepage    = "https://github.com/andresbravog/signnow-ruby"
+  s.summary     = %q{API wrapper for Signnow.}
+  s.description = %q{API wrapper for Signnow.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "json"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+end

data/spec/signnow/base_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Signnow::Base do
+  describe "#parse_timestamps" do
+    context "given #created is present" do
+      it "creates a Time object" do
+        base = Signnow::Base.new(created: 1358300444)
+        base.created.class.should eql(Time)
+      end
+    end
+  end
+end

data/spec/signnow/client_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Signnow::Client do
+  let(:valid_attributes) do
+      JSON.parse %{
+        {
+          "id": "23f2f9dc10e0f12883f78e91296207640dede6d1",
+          "first_name": "Test",
+          "last_name": "User",
+          "active": "1",
+          "type": 1,
+          "pro": 0,
+          "created": "1358945328",
+          "emails": ["hola+test@andresbravo.com"],
+          "identity": {
+              "Identified": "No",
+              "Status": "First attempt",
+              "OKToRetry": true
+          },
+          "subscriptions": [],
+          "credits": 0,
+          "has_atticus_access": false,
+          "is_logged_in": true,
+          "teams": []
+        }
+      }
+  end
+
+  let (:client) do
+    Signnow::Client.new(user_access_token)
+  end
+
+  let(:user_access_token) { '_user_access_token_' }
+
+  describe "#initialize" do
+    it 'initializes attributes correctly' do
+      client.access_token.should eql(user_access_token)
+    end
+  end
+
+  describe "#perform!" do
+    before :each do
+      allow(Signnow).to receive(:request).and_return(valid_attributes)
+    end
+    it "executes requests inside the block" do
+      expect(Signnow).to receive(:request).with(:get, nil, "user", {}, { auth_type: :user_token, auth_token: user_access_token })
+      client.perform! do |token|
+        Signnow::User.show(access_token: token)
+      end
+    end
+  end
+
+end

data/spec/signnow/document_spec.rb

@@ -0,0 +1,188 @@
+require "spec_helper"
+
+describe Signnow::Document do
+  let(:valid_attributes) do
+      JSON.parse %{
+        {
+            "id": "9e30bb3094e00abc291016a7a597ba1840a6d6ec",
+            "user_id": "adb16da39e5ecc448e2aa4aec8a34a8158fa137a",
+            "document_name": "sample.pdf",
+            "page_count": "1",
+            "created": "1358300444",
+            "updated": "1358300444",
+            "original_filename": "sample.pdf",
+            "thumbnail": {
+                "small": "https:\/\/api.signnow.com\/document\/9e30bb3094e00abc291016a7a597ba1840a6d6ec\/thumbnail?size=small",
+                "medium": "https:\/\/api.signnow.com\/document\/9e30bb3094e00abc291016a7a597ba1840a6d6ec\/thumbnail?size=medium",
+                "large": "https:\/\/api.signnow.com\/document\/9e30bb3094e00abc291016a7a597ba1840a6d6ec\/thumbnail?size=large"
+            },
+            "signatures": [],
+            "seals": [],
+            "texts": [],
+            "inserts": [],
+            "tags": [],
+            "fields": [],
+            "requests": [],
+            "notary_invites": [],
+            "version_time": "1358300444"
+        }
+      }
+  end
+
+  let(:valid_all_response) do
+    JSON.parse %{
+        [{
+            "id": "9e30bb3094e00abc291016a7a597ba1840a6d6ec",
+            "user_id": "adb16da39e5ecc448e2aa4aec8a34a8158fa137a",
+            "document_name": "sample.pdf",
+            "page_count": "1",
+            "created": "1358300444",
+            "updated": "1358300444",
+            "original_filename": "sample.pdf",
+            "thumbnail": {
+                "small": "https:\/\/api.signnow.com\/document\/9e30bb3094e00abc291016a7a597ba1840a6d6ec\/thumbnail?size=small",
+                "medium": "https:\/\/api.signnow.com\/document\/9e30bb3094e00abc291016a7a597ba1840a6d6ec\/thumbnail?size=medium",
+                "large": "https:\/\/api.signnow.com\/document\/9e30bb3094e00abc291016a7a597ba1840a6d6ec\/thumbnail?size=large"
+            },
+            "signatures": [],
+            "seals": [],
+            "texts": [],
+            "inserts": [],
+            "tags": [],
+            "fields": [],
+            "requests": [],
+            "notary_invites": [],
+            "version_time": "1358300444"
+        }, {
+            "id": "321e1c74ada708f442bf3f9529ed0d44b3628796",
+            "user_id": "adb16da39e5ecc448e2aa4aec8a34a8158fa137a",
+            "document_name": "sample.pdf",
+            "page_count": "1",
+            "created": "1341248871",
+            "updated": "1341248871",
+            "original_filename": "sample.pdf",
+            "thumbnail": {
+                "small": "https:\/\/api.signnow.com\/document\/321e1c74ada708f442bf3f9529ed0d44b3628796\/thumbnail?size=small",
+                "medium": "https:\/\/api.signnow.com\/document\/321e1c74ada708f442bf3f9529ed0d44b3628796\/thumbnail?size=medium",
+                "large": "https:\/\/api.signnow.com\/document\/321e1c74ada708f442bf3f9529ed0d44b3628796\/thumbnail?size=large"
+            },
+            "signatures": [],
+            "seals": [],
+            "texts": [],
+            "inserts": [],
+            "tags": [],
+            "fields": [],
+            "requests": [{
+                "unique_id": "1cb9d8e6b26d6ececc4f4c9d08aaaa28e10fa80f",
+                "id": "1cb9d8e6b26d6ececc4f4c9d08aaaa28e10fa80f",
+                "user_id": "adb16da39e5ecc448e2aa4aec8a34a8158fa137a",
+                "created": "1349903957",
+                "originator_email": "user@test.com",
+                "signer_email": "signer@test.com"
+            }],
+            "notary_invites": [],
+            "version_time": "1341248871"
+        }, {
+            "id": "1db4c6ba33332f655cb2eda468743c1d040ae079",
+            "user_id": "adb16da39e5ecc448e2aa4aec8a34a8158fa137a",
+            "document_name": "sample.pdf",
+            "page_count": "1",
+            "created": "1335819071",
+            "updated": "1335819071",
+            "original_filename": "sample.pdf",
+            "thumbnail": {
+                "small": "https:\/\/api.signnow.com\/document\/1db4c6ba33332f655cb2eda468743c1d040ae079\/thumbnail?size=small",
+                "medium": "https:\/\/api.signnow.com\/document\/1db4c6ba33332f655cb2eda468743c1d040ae079\/thumbnail?size=medium",
+                "large": "https:\/\/api.signnow.com\/document\/1db4c6ba33332f655cb2eda468743c1d040ae079\/thumbnail?size=large"
+            },
+            "signatures": [],
+            "seals": [],
+            "texts": [],
+            "inserts": [],
+            "tags": [],
+            "fields": [],
+            "requests": [{
+                "unique_id": "5d8ce45d8e27c7ed717d7d23117200c72442ee3e",
+                "id": "5d8ce45d8e27c7ed717d7d23117200c72442ee3e",
+                "user_id": "adb16da39e5ecc448e2aa4aec8a34a8158fa137a",
+                "created": "1335819085",
+                "originator_email": "jane@test.com",
+                "signer_email": "signer@test.com"
+            }],
+            "notary_invites": [],
+            "version_time": "1335819071"
+        }]
+    }
+  end
+
+  let (:document) do
+    Signnow::Document.new(valid_attributes)
+  end
+
+  let(:user_access_token) { '_user_access_token_' }
+
+  describe "#initialize" do
+    it 'initializes all attributes correctly' do
+      document.id.should eql('9e30bb3094e00abc291016a7a597ba1840a6d6ec')
+      document.user_id.should eql('adb16da39e5ecc448e2aa4aec8a34a8158fa137a')
+      document.document_name.should eql('sample.pdf')
+      document.page_count.should eql('1')
+      document.original_filename.should eql('sample.pdf')
+    end
+  end
+
+  describe ".show" do
+    let(:document_show) { Signnow::Document.show(access_token: user_access_token, id: document.id ) }
+    before :each do
+      allow(Signnow).to receive(:request).and_return(valid_attributes)
+    end
+    it "makes a new GET request using the correct API endpoint to receive a specific user" do
+      expect(Signnow).to receive(:request).with(:get, nil, "document/#{document.id}", {}, { auth_type: :user_token, auth_token: user_access_token })
+      document_show
+    end
+    it 'returns a user with the correct id' do
+      expect(document_show.id).to eql('9e30bb3094e00abc291016a7a597ba1840a6d6ec')
+    end
+    it 'returns a user with the correct document_name' do
+      expect(document_show.document_name).to eql('sample.pdf')
+    end
+    it 'returns a user with the correct original_filename' do
+      expect(document_show.original_filename).to eql('sample.pdf')
+    end
+  end
+
+  describe ".download_link" do
+    let(:document_download_link) { Signnow::Document.download_link(access_token: user_access_token, id: document.id ) }
+    let(:valid_link_attributes) do
+      JSON.parse %{
+        {
+          "link": "https://signnow.com/dispatch?route=onetimedownload&document_download_id=67de624701a70cdfe208b5c537f61fefa48b410a"
+        }
+      }
+    end
+    before :each do
+      allow(Signnow).to receive(:request).and_return(valid_link_attributes)
+    end
+    it "makes a new GET request using the correct API endpoint to receive a specific user" do
+      expect(Signnow).to receive(:request).with(:post, nil, "document/#{document.id}/download/link", {}, { auth_type: :user_token, auth_token: user_access_token })
+      document_download_link
+    end
+    it 'returns a user with the correct link' do
+      expect(document_download_link).to eql('https://signnow.com/dispatch?route=onetimedownload&document_download_id=67de624701a70cdfe208b5c537f61fefa48b410a')
+    end
+  end
+
+  describe ".all" do
+    let(:document_all) { Signnow::Document.all(access_token: user_access_token) }
+    before :each do
+      allow(Signnow).to receive(:request).and_return(valid_all_response)
+    end
+    it "makes a new POST request using the correct API endpoint" do
+      expect(Signnow).to receive(:request).with(:get, nil, "user/documentsv2", {}, { auth_type: :user_token, auth_token: user_access_token })
+      document_all
+    end
+    it 'returns a user with the correct id' do
+      expect(document_all.first.id).to eql('9e30bb3094e00abc291016a7a597ba1840a6d6ec')
+    end
+  end
+end