hellosign-api 1.0.0

data/spec/hello_sign/client_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+
+describe HelloSign::Client do
+  describe '#initialize' do
+    context 'with default values' do
+      subject(:client) { HelloSign::Client.new }
+      HelloSign::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        it "should set #{key}" do
+          expect(client.send(key)).to eql(HelloSign.send(key))
+        end
+      end
+    end
+
+    context 'with custom values' do
+      let(:custom_client){
+        {
+          :email_address => 'email_address',
+          :password => 'password',
+          :api_key => 'api_key',
+          :user_agent => 'user_agent',
+          :end_point => 'end_point',
+          :oauth_end_point => 'oauth_end_point',
+          :api_version => 'api_version',
+          :client_id => 'client_id',
+          :client_secret => 'client_secret',
+          :auth_token => 'auth_token',
+          :log_level => 5,
+          :logging => false,
+          :proxy_uri => 'proxy_uri',
+          :proxy_user => 'proxy_user',
+          :proxy_pass => 'proxy_pass',
+          :timeout => 240
+        }
+      }
+      subject(:client) { HelloSign::Client.new custom_client }
+      HelloSign::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        it "should set #{key}" do
+          expect(client.send(key)).to eql(custom_client[key])
+        end
+      end
+
+      it "should create a new HelloSign Client" do
+        expect(client).to be_an_instance_of(HelloSign::Client)
+      end
+
+      it "should have 'timeout' as a parameter" do
+        expect(client.timeout).to eq(240)
+      end
+    end
+  end
+
+  describe '#request' do
+    def post_request(key)
+      stub_post('/account/create', 'error', key)
+      HelloSign.create_account :email_address => 'test@example.com', :password => 'password'
+    end
+
+    def get_request(key)
+      stub_get('/account', 'error', key)
+      HelloSign.get_account
+    end
+
+    HelloSign::Client::ERRORS.keys.each do |key|
+      context "when response status #{key}" do
+        it "raise #{HelloSign::Client::ERRORS[key].to_s} on post" do
+          expect { post_request(key) }.to raise_error(HelloSign::Client::ERRORS[key])
+        end
+
+        it "raise #{HelloSign::Client::ERRORS[key].to_s} on get" do
+          expect { get_request(key) }.to raise_error(HelloSign::Client::ERRORS[key])
+        end
+      end
+    end
+
+    context 'when response status not listed' do
+      it 'raise UnknownError for post' do
+        expect { post_request(504) }.to raise_error(HelloSign::Error::UnknownError)
+      end
+
+      it 'raise UnknownError for get' do
+        expect { get_request(504) }.to raise_error(HelloSign::Error::UnknownError)
+      end
+    end
+
+    describe 'error keys are set' do
+      let(:error) do
+        begin
+          get_request(400)
+        rescue => e
+          e
+        else
+          # Defense exception:
+          raise 'Expected stub to throw exception'
+        end
+      end
+
+      describe 'message' do
+        subject  { error.message }
+        # Following test proves backwards compatibility
+        it { is_expected.to match(/Server responded.*/) }
+      end
+
+      describe 'response_body' do
+        subject { error.response_body }
+        it { is_expected.to eql(load_fixture('error').read) }
+      end
+
+      describe 'response_status' do
+        subject { error.response_status }
+        it { is_expected.to eql(400) }
+      end
+
+      describe 'request_uri' do
+        subject { error.request_uri }
+        it { is_expected.to eql('https://api.hellosign.com/v3/account') }
+      end
+    end
+  end
+
+  describe 'prepare' do
+    context 'signers' do
+      describe 'is an array' do
+        before do
+          stub_post('/signature_request/send', 'signature_request')
+        end
+
+        it 'work correctly' do
+          expect(lambda{ HelloSign.send_signature_request(
+            :files_url => ['http://hellosign.com/test.pdf'],
+            :signers => ['sss']
+          ) }).not_to raise_error
+        end
+      end
+
+      describe 'is an Hash' do
+        before do
+          stub_post('/signature_request/send', 'signature_request')
+        end
+
+        it 'work correctly' do
+          expect(lambda{ HelloSign.send_signature_request(
+            :files_url => ['http://hellosign.com/test.pdf'],
+            :signers => [{
+              :email_address => 'jack@example.com',
+              :name => 'Jack',
+              :order => 0
+            }, {
+              :email_address => 'jill@example.com',
+              :name => 'Jill',
+              :order => 1
+            }]
+          ) }).not_to raise_error
+        end
+      end
+    end
+
+    context 'ccs' do
+      describe 'is an array' do
+        before do
+          stub_post('/signature_request/send_with_template', 'signature_request')
+        end
+
+        it 'work correctly' do
+          expect(lambda{ HelloSign.send_signature_request_with_template(
+            :ccs => ['sss']
+          ) }).not_to raise_error
+        end
+      end
+
+      describe 'is an Hash' do
+        before do
+          stub_post('/signature_request/send_with_template', 'signature_request')
+        end
+
+        it 'work correctly' do
+          expect(lambda{ HelloSign.send_signature_request_with_template(
+            :ccs => [{
+              :email_address => 'jack@example.com',
+              :name => 'Jack',
+              :role => 'Manager'
+            }, {
+              :email_address => 'jill@example.com',
+              :name => 'Jill',
+              :role => 'Client'
+            }]
+          ) }).not_to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/hello_sign/error_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe HelloSign::Error do
+  # another test to prove backwards compatibility
+  it 'raises an error with any message' do
+    error = HelloSign::Error::Error.new(404, 'test error message', 'http://www.test.com')
+    expect(error).to be_instance_of(HelloSign::Error::Error)
+  end
+
+end

data/spec/hello_sign/resource/base_resource_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe HelloSign::Resource::BaseResource do
+  let(:data){
+    { :body => {
+        :a => :a1,
+        :b => :b1,
+        :c => { :c1 => :c2 },
+        :d => [:d1, :d2, :d3],
+        :e => [{ :e1 => :e11 }, { :e2 => :e21 }, { :e3 => :e31 }]
+      }
+    }
+  }
+
+  describe 'methods' do
+    subject(:resource) { HelloSign::Resource::BaseResource.new data }
+
+    it 'can access attributes by calling method with the same name' do
+      data.keys.each do |key|
+        expect(resource.send key).not_to be_nil
+      end
+    end
+
+    it 'make a hash value into a new HelloSign::Resource::BaseResource' do
+      expect(resource.data["body"].data["c"]).to be_an HelloSign::Resource::BaseResource
+    end
+
+    it 'do not touch array value with basic type' do
+      expect(resource.d).to eql(data[:d])
+    end
+
+    it 'make a array value with each item is a hash into array of HelloSign::Resource::BaseResource' do
+      expect(resource.data["body"].data["e"]).to be_an Array
+      expect(resource.data["body"].data["e"][0]).to be_an HelloSign::Resource::BaseResource
+    end
+  end
+
+  describe '#initialize' do
+    context 'without key params' do
+      subject(:resource) { HelloSign::Resource::BaseResource.new data }
+      it 'have correct data' do
+        expect(resource.raw_data).to eql(data)
+      end
+    end
+
+    context 'with key params' do
+      subject(:resource) { HelloSign::Resource::BaseResource.new data, :e }
+      it 'have correct data' do
+        expect(resource.raw_data).to eql(data[:body][:e])
+      end
+    end
+  end
+end

data/spec/hello_sign_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+describe HelloSign do
+  after { HelloSign.reset }
+
+  describe '.client' do
+    it 'should be a HelloSign::Client' do
+      expect(HelloSign.client).to be_a(HelloSign::Client)
+    end
+  end
+
+  describe '.configure' do
+    HelloSign::Configuration::VALID_OPTIONS_KEYS.each do |key|
+      it "should set #{key}" do
+        HelloSign.configure do |config|
+          config.send("#{key}=", key)
+          expect(HelloSign.send(key)).to eql(key)
+        end
+      end
+    end
+  end
+
+  describe '.user_agent=' do
+    it 'should set user_agent' do
+      HelloSign.user_agent = 'Custom User Agent'
+      expect(HelloSign.user_agent).to eql('Custom User Agent')
+    end
+  end
+
+  describe '.user_agent' do
+    it 'should return default user_agent' do
+      expect(HelloSign.user_agent).to eql(HelloSign::Configuration::DEFAULT_USER_AGENT)
+    end
+  end
+end

data/spec/scenarios/uploads_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'Uploading File' do
+  describe 'Create Embedded Signature Request' do
+    before { stub_post('/signature_request/create_embedded', 'signature_request') }
+
+    it 'works with simple pdf' do
+      expect(HelloSign.create_embedded_signature_request({files: ['spec/fixtures/nda.pdf']}))
+    end
+  end
+
+  describe 'Create Unclaimed Draft' do
+    before { stub_post('/unclaimed_draft/create', 'unclaimed_draft') }
+
+    it 'works with simple pdf' do
+      expect(HelloSign.create_unclaimed_draft({files: ['spec/fixtures/nda.pdf']}))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,104 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'webmock/rspec'
+require 'pry'
+require File.expand_path('../../lib/hello_sign', __FILE__)
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+def load_fixture(name)
+  File.new(File.dirname(__FILE__) + "/fixtures/#{name}.json")
+end
+
+def load_file(name)
+  File.read(File.new(File.dirname(__FILE__) + "/fixtures/#{name}"))
+end
+
+def stub_get(path, fixture, status_code=200)
+  stub_request(:get, "#{HelloSign.end_point}#{HelloSign.api_version}#{path}").
+    to_return(:headers => load_fixture("headers"), :body => load_fixture(fixture), :status => status_code)
+end
+
+def a_get(path)
+  a_request(:get, "#{HelloSign.end_point}#{HelloSign.api_version}#{path}")
+end
+
+def stub_post(path, fixture, status_code=200)
+  stub_request(:post, "#{HelloSign.end_point}#{HelloSign.api_version}#{path}").
+    to_return(:headers => load_fixture("headers"), :body => load_fixture(fixture), :status => status_code)
+end
+
+def stub_post_oauth(path, fixture, status_code=200)
+  stub_request(:post, "#{HelloSign.oauth_end_point}#{path}").
+    to_return(:body => load_fixture(fixture), :status => status_code)
+end
+
+def a_post(path)
+  a_request(:post, "#{HelloSign.end_point}#{HelloSign.api_version}#{path}")
+end
+
+def a_post_oauth(path)
+  a_request(:post, "#{HelloSign.oauth_end_point}#{path}")
+end
+
+def stub_put(path, fixture)
+  stub_request(:put, "#{HelloSign.end_point}#{HelloSign.api_version}#{path}").
+    to_return(:body => load_fixture(fixture))
+end
+
+def a_put(path)
+  a_request(:put, "#{HelloSign.end_point}#{HelloSign.api_version}#{path}")
+end
+
+def stub_delete(path, fixture)
+  stub_request(:delete, "#{HelloSign.end_point}#{HelloSign.api_version}#{path}").
+    to_return(:body => load_fixture(fixture))
+end
+
+def a_delete(path)
+  a_request(:delete, "#{HelloSign.end_point}#{HelloSign.api_version}#{path}")
+end

metadata

@@ -0,0 +1,261 @@
+--- !ruby/object:Gem::Specification
+name: hellosign-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- HelloSign, Aubrey Holland
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: ''
+email: aubrey@withgrayce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- hellosign-api.gemspec
+- lib/hello_sign.rb
+- lib/hello_sign/.error.rb.swp
+- lib/hello_sign/api.rb
+- lib/hello_sign/api/account.rb
+- lib/hello_sign/api/api_app.rb
+- lib/hello_sign/api/bulk_send_job.rb
+- lib/hello_sign/api/embedded.rb
+- lib/hello_sign/api/oauth.rb
+- lib/hello_sign/api/signature_request.rb
+- lib/hello_sign/api/team.rb
+- lib/hello_sign/api/template.rb
+- lib/hello_sign/api/unclaimed_draft.rb
+- lib/hello_sign/client.rb
+- lib/hello_sign/configuration.rb
+- lib/hello_sign/error.rb
+- lib/hello_sign/resource.rb
+- lib/hello_sign/resource/account.rb
+- lib/hello_sign/resource/api_app.rb
+- lib/hello_sign/resource/base_resource.rb
+- lib/hello_sign/resource/bulk_send_job.rb
+- lib/hello_sign/resource/embedded.rb
+- lib/hello_sign/resource/resource_array.rb
+- lib/hello_sign/resource/signature_request.rb
+- lib/hello_sign/resource/team.rb
+- lib/hello_sign/resource/template.rb
+- lib/hello_sign/resource/template_draft.rb
+- lib/hello_sign/resource/unclaimed_draft.rb
+- lib/hello_sign/version.rb
+- lib/hellosign-ruby-sdk.rb
+- spec/fixtures/account.json
+- spec/fixtures/api_app.json
+- spec/fixtures/api_apps.json
+- spec/fixtures/bulk_send_job.json
+- spec/fixtures/bulk_send_jobs.json
+- spec/fixtures/embedded.json
+- spec/fixtures/empty.pdf
+- spec/fixtures/error.json
+- spec/fixtures/file.json
+- spec/fixtures/headers.json
+- spec/fixtures/nda.pdf
+- spec/fixtures/signature_request.json
+- spec/fixtures/signature_requests.json
+- spec/fixtures/team.json
+- spec/fixtures/template.json
+- spec/fixtures/templates.json
+- spec/fixtures/token.json
+- spec/fixtures/unclaimed_draft.json
+- spec/hello_sign/.error_spec.rb.swp
+- spec/hello_sign/api/account_spec.rb
+- spec/hello_sign/api/api_app_spec.rb
+- spec/hello_sign/api/bulk_send_job_spec.rb
+- spec/hello_sign/api/embedded_spec.rb
+- spec/hello_sign/api/oauth_spec.rb
+- spec/hello_sign/api/signature_request_spec.rb
+- spec/hello_sign/api/team_spec.rb
+- spec/hello_sign/api/template_spec.rb
+- spec/hello_sign/api/unclaimed_draft_spec.rb
+- spec/hello_sign/client_spec.rb
+- spec/hello_sign/error_spec.rb
+- spec/hello_sign/resource/base_resource_spec.rb
+- spec/hello_sign_spec.rb
+- spec/scenarios/uploads_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.hellosign.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: A Ruby SDK for the HelloSign API.
+test_files:
+- spec/fixtures/account.json
+- spec/fixtures/api_app.json
+- spec/fixtures/api_apps.json
+- spec/fixtures/bulk_send_job.json
+- spec/fixtures/bulk_send_jobs.json
+- spec/fixtures/embedded.json
+- spec/fixtures/empty.pdf
+- spec/fixtures/error.json
+- spec/fixtures/file.json
+- spec/fixtures/headers.json
+- spec/fixtures/nda.pdf
+- spec/fixtures/signature_request.json
+- spec/fixtures/signature_requests.json
+- spec/fixtures/team.json
+- spec/fixtures/template.json
+- spec/fixtures/templates.json
+- spec/fixtures/token.json
+- spec/fixtures/unclaimed_draft.json
+- spec/hello_sign/.error_spec.rb.swp
+- spec/hello_sign/api/account_spec.rb
+- spec/hello_sign/api/api_app_spec.rb
+- spec/hello_sign/api/bulk_send_job_spec.rb
+- spec/hello_sign/api/embedded_spec.rb
+- spec/hello_sign/api/oauth_spec.rb
+- spec/hello_sign/api/signature_request_spec.rb
+- spec/hello_sign/api/team_spec.rb
+- spec/hello_sign/api/template_spec.rb
+- spec/hello_sign/api/unclaimed_draft_spec.rb
+- spec/hello_sign/client_spec.rb
+- spec/hello_sign/error_spec.rb
+- spec/hello_sign/resource/base_resource_spec.rb
+- spec/hello_sign_spec.rb
+- spec/scenarios/uploads_spec.rb
+- spec/spec_helper.rb