hellosign-ruby-sdk 3.7.7 → 6.0.0.pre.beta

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.idea
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.DS_Store

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.1
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
-  - ruby-head
-  - jruby-head
-
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: ruby-head
-  fast_finish: true

data/CONTRIBUTING.md

@@ -1,42 +0,0 @@
-# How to contribute
-
-We're excited you're considering contributing to our project! Your patches are essential to keeping our SDKs bug free and up-to-date. We want to keep it as easy as possible to contribute. There are only a few guidelines you must follow that will allow us to keep up with pull requests and maintain a high quality code base.
-
-## Getting Started
-
-* Make sure you have a [GitHub account](https://github.com/signup/free)
-* Make sure you have a [HelloSign account](http://www.hellosign.com)
-* Submit a new [issue ticket](https://github.com/HelloFax/hellosign-ruby-sdk/issues), assuming one does not already exist.
-  * Clearly describe the issue including steps to reproduce when it is a bug.
-  * Make sure to include the version you are using which has the issue (and confirm that the issue you are having has not been fixed in a later version)
-* Fork the repository on GitHub
-
-## Making Changes
-
-* Make commits of logical units.
-* Check for unnecessary whitespace with `git diff --check` before committing.
-* Make sure your commit messages are in [the proper format](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
-* Make sure you have added any necessary tests for your changes.
-* Run all unit tests, if available, to ensure nothing else was accidentally broken.
-
-### Making trivial changes
-
-For changes of a trivial nature to comments and documentation, it is not
-always necessary to create a new issue ticket.
-
-## Submitting Changes
-
-* Push your changes to your fork of the repository.
-* Submit a pull request to the repository in the HelloFax organization.
-* Update your issue ticket to mark that you have submitted code and are ready for it to be reviewed (Status: Ready for Merge).
-  * Include a link to the pull request in the ticket.
-* The HelloSign dev team looks at Pull Requests on a regular basis.
-* After feedback has been given we expect responses within two weeks. After two
-  weeks we may close the pull request if it isn't showing any activity.
-
-# Additional Resources
-
-* [General GitHub documentation](http://help.github.com/)
-* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
-* [HelloSign API documentation](https://app.hellosign.com/api/documentation)
-* [HelloSign API HipChat room](https://www.hipchat.com/gq4BMFKt1)

data/Guardfile

@@ -1,14 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-notification :growl if `uname` =~ /Darwin/
-
-guard :bundler do
-  watch('Gemfile')
-end
-
-guard :rspec do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/lib/hello_sign/api/account.rb

@@ -1,78 +0,0 @@
-# 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.
-
-module HelloSign
-  module Api
-    # Contains all the API calls for the Account resource.
-    # Take a look at our API Documentation on the Account resource (https://app.hellosign.com/api/reference#Account)
-    # for more information about this.
-    #
-    # @author [hellosign]
-
-    module Account
-
-      # Returns the current user's account information.
-      #
-      # @return [HelloSign::Resource::Account] Current user's Account
-      #
-      # @example
-      #   account = @client.get_account
-      def get_account
-        HelloSign::Resource::Account.new get('/account')
-      end
-
-      # Creates a new HelloSign account. The user will need to confirm the email address
-      # to complete the creation process.
-      # @option opts [String] email_address New user's email address
-      #
-      # @return [HelloSign::Resource::Account] New user's Account
-      #
-      # @example
-      #   account = @client.create_account email_address: 'newuser@example.com'
-      def create_account(opts)
-        HelloSign::Resource::Account.new post('/account/create', body: opts)
-      end
-
-      # Updates the current user's Account Callback URL.
-      # @option opts [String] callback_url New callback URL
-      #
-      # @return [HelloSign::Resource::Account] Updated Account
-      #
-      # @example
-      #   account = @client.update_account callback_url: 'https://www.example.com/callback'
-      def update_account(opts)
-        HelloSign::Resource::Account.new post('/account', body: opts)
-      end
-
-      # Checks whether an Account exists
-      # @option opts [String] email_address User's email address
-      #
-      # @return [Bool] true if exists, else false
-      #
-      # @example
-      #   account = @client.verify email_address: 'newuser@example.com'
-      def verify(opts)
-        post('/account/verify', body: opts).empty? ? false : true
-      end
-    end
-  end
-end

data/lib/hello_sign/api/api_app.rb

@@ -1,121 +0,0 @@
-# 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.
-
-module HelloSign
-  module Api
-    # Contains all the API calls for the ApiApp resource.
-    # Take a look at our API Documentation on ApiApps (https://app.hellosign.com/api/reference#ApiApp)
-    # for more information about this.
-    #
-    # @author [hellosign]
-
-    module ApiApp
-
-      # Retrieves an ApiApp with a given ID
-      # @option opts [String] client_id The Client ID of the ApiApp.
-      #
-      # @return [HelloSign::Resource::ApiApp]
-      #
-      # @example
-      #   app = @client.get_api_app client_id: 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
-      def get_api_app(opts)
-        HelloSign::Resource::ApiApp.new get("/api_app/#{opts[:client_id]}")
-      end
-
-      # Returns a list of ApiApps that your Account can access.
-      # @option opts [Integer] page Sets the page number of the list to return. Defaults to 1. (optional)
-      # @option opts [Integer] page_size Determines the number of ApiApps returned per page. Defaults to 20. (optional)
-      #
-      # @return [HelloSign::Resource::ResourceArray]
-      #
-      # @example
-      #   apps = @client.get_api_apps page: 1
-      def get_api_apps(opts={})
-        path = '/api_app/list'
-        path += opts[:page] ? "?page=#{opts[:page]}" : ''
-        path += opts[:page_size] ? "&page_size=#{opts[:page_size]}" : ''
-        HelloSign::Resource::ResourceArray.new get(path, opts), 'api_apps',  HelloSign::Resource::ApiApp
-      end
-
-      # Creates a new ApiApp on your Account
-      # @option opts [String] name The name assigned to the ApiApp.
-      # @option opts [String] domain The domain associated with the ApiApp.
-      # @option opts [String] callback_url The URL that will receive callback events for the ApiApp. (optional)
-      # @option opts [String] custom_logo_file An image file to use as a custom logo in embedded workflows, if available in the API subscription. (optional)
-      # @option opts [String] oauth[callback_url] The callback URL to be used for OAuth flows. (optional)
-      # @option opts [String] oauth[scopes] A comma-separated list of OAuth scopes to be granted to the app. (optional)
-      # @option opts [String<Hash>] white_labeling_options Object with elements and values serialized to a string to customize the signer page, if available in the API subscription. (optional)
-      # @option opts [Boolean] options[can_insert_everywhere] Determines if signers can "Insert Everywhere" when signing a document. (optional)
-      #
-      # @return [HelloSign::Resource::ApiApp] newly created ApiApp
-      #
-      # @example
-      #   app = @client.create_api_app(
-      #     name: 'My Production App',
-      #     domain: 'example.com',
-      #     'oauth[callback_url]': 'https://example.com/oauth',
-      #     'oauth[scopes]': 'basic_account_info,request_signature'
-      #   )
-      def create_api_app(opts)
-        HelloSign::Resource::ApiApp.new post('/api_app', body: opts)
-      end
-
-      # Updates the ApiApp settings.
-      # @option opts [String] client_id The Client ID of the ApiApp you want to update.
-      # @option opts [String] name The name assigned to the ApiApp. (optional)
-      # @option opts [String] domain The domain associated with the ApiApp. (optional)
-      # @option opts [String] callback_url The URL that will receive callback events for the ApiApp. (optional)
-      # @option opts [String] custom_logo_file An image file to use as a custom logo in embedded workflows, if available in the API subscription. (optional)
-      # @option opts [String] oauth[callback_url] The callback URL to be used for OAuth flows. (optional)
-      # @option opts [String] oauth[scopes] A comma-separated list of OAuth scopes to be granted to the app. (optional)
-      # @option opts [String<Hash>] white_labeling_options Object with elements and values serialized to a string to customize the signer page, if available in the API subscription. (optional)
-      # @option opts [Boolean] options[can_insert_everywhere] Determines if signers can "Insert Everywhere" when signing a document. (optional)
-      #
-      # @return [HelloSign::Resource::ApiApp] an ApiApp object
-      #
-      # @example
-      #   app = @client.update_api_app(
-      #     name: 'My Newly Renamed App',
-      #     domain: 'example2.com',
-      #     'oauth[callback_url]': 'https://example2.com/oauth',
-      #     'oauth[scopes]': 'basic_account_info, request_signature'
-      #   )
-      def update_api_app(opts)
-        id = opts.delete(:client_id)
-        path = '/api_app/' + id
-        HelloSign::Resource::ApiApp.new post(path, body: opts)
-      end
-
-      # Deletes an ApiApp. Only available for ApiApps you own.
-      # @option opts [String] client_id The Client ID of the ApiApp you want to delete.
-      #
-      # @return [HTTP::Status] 204 No Content
-      #
-      # @example
-      #   response = @client.delete_api_app client_id: 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
-      def delete_api_app(opts)
-        path = '/api_app/' + opts[:client_id]
-        delete(path)
-      end
-    end
-  end
-end

data/lib/hello_sign/api/bulk_send_job.rb

@@ -1,62 +0,0 @@
-# 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.
-
-module HelloSign
-  module Api
-    # Contains all the API calls for the BulkSendJob resource.
-    # Take a look at our API Documentation on BulkSendJobs (https://app.hellosign.com/api/reference#BulkSendJob)
-    # for more information about this.
-    #
-    # @author [hellosign]
-
-    module BulkSendJob
-
-      # Retrieves a BulkSendJob with a given ID
-      # @option opts [String] bulk_send_job_id The BulkSendJob ID to retrieve.
-      #
-      # @return [HelloSign::Resource::BulkSendJob]
-      #
-      # @example
-      #   bulk_send_job = @client.get_bulk_send_job bulk_send_job_id: 'af299494bdcad318b4856aa34aa263dbdaaee9ab'
-      def get_bulk_send_job(opts)
-        path = "/bulk_send_job/#{opts[:bulk_send_job_id]}"
-
-        HelloSign::Resource::BulkSendJob.new get(path)
-      end
-
-      # Returns a list of BulkSendJobs that your Account can access.
-      # @option opts [Integer] page Sets the page number of the list to return. Defaults to 1. (optional)
-      # @option opts [Integer] page_size Determines the number of BulkSendJobs returned per page. Defaults to 20. (optional)
-      #
-      # @return [HelloSign::Resource::ResourceArray]
-      #
-      # @example
-      #   bulk_send_jobs = @client.get_bulk_send_jobs page: 1
-      def get_bulk_send_jobs(opts={})
-        path = '/bulk_send_job/list'
-        path += opts[:page] ? "?page=#{opts[:page]}" : ''
-        path += opts[:page_size] ? "&page_size=#{opts[:page_size]}" : ''
-        HelloSign::Resource::ResourceArray.new get(path, opts), 'bulk_send_jobs', HelloSign::Resource::BulkSendJob
-      end
-    end
-  end
-end

data/lib/hello_sign/api/embedded.rb

@@ -1,68 +0,0 @@
-# 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.
-
-module HelloSign
-  module Api
-    # Contains all the API calls for Embedded SignatureRequests.
-    # Take a look at our Embedded Signing Walkthrough (https://app.hellosign.com/api/embeddedSigningWalkthrough)
-    # for more information about this.
-    #
-    # @author [hellosign]
-
-    module Embedded
-
-      # Retrieves the sign_url for an Embedded SignatureRequest.
-      # @option opts [String] signature_id The Signature ID to retrieve the embedded sign_url for.
-      #
-      # @return [HelloSign::Resource::Embedded]
-      #
-      # @example
-      #   embedded = @client.get_embedded_sign_url signature_id: '50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b'
-      def get_embedded_sign_url(opts)
-        HelloSign::Resource::Embedded.new get("/embedded/sign_url/#{opts[:signature_id]}")
-      end
-
-      # Retrieves the edit_url for an Embedded Template.
-      # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. Defaults to 0. (optional)
-      # @option opts [String] template_id The Template ID to retrieve the embedded edit_url for.
-      # @option opts [Array<Hash>] cc_roles The CC roles that must be assigned when using the Embedded Template to create a SignatureRequest. (optional)
-      # @option opts [String<Array><Hash>] merge_fields List of fields that can be pre-populated by your application when using the Embedded Template to send a SignatureRequest. (optional)
-      #   * name (String) Merge field name
-      #   * type (String) Field type - either "text" or "checkbox"
-      # @option opts [Boolean] skip_signer_roles Removes the prompt to edit signer roles, if already provided. Defaults to 0. (optional)
-      # @option opts [Boolean] skip_subject_message Removes the prompt to edit the subject and message, if already provided. Defaults to 0. (optional)
-      #
-      # @return [HelloSign::Resource::Embedded]
-      #
-      # @example
-      #   edit_url = @client.get_embedded_template_edit_url template_id: '39e3387f738adfa7ddd4cbd4c00d2a8ab6e4194b'
-      def get_embedded_template_edit_url(opts)
-        defaults = { skip_signer_roles: 0, skip_subject_message: 0, test_mode: 0 }
-        opts = defaults.merge(opts)
-
-        prepare_merge_fields opts
-
-        HelloSign::Resource::Embedded.new post("/embedded/edit_url/#{opts[:template_id]}", body: opts)
-      end
-    end
-  end
-end

data/lib/hello_sign/api/oauth.rb

@@ -1,95 +0,0 @@
-# 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.
-
-module HelloSign
-  module Api
-    # Contains all the API calls for OAuth workflows.
-    # OAuth allows you to perform actions on behalf of other users after they grant you the authorization to do so.
-    # See our OAuth API documentation (https://app.hellosign.com/api/oauthWalkthrough) for more information.
-    #
-    # @author [hellosign]
-
-    module OAuth
-
-      # Returns the OAuth URL where users can authorize your application to perform actions on their behalf.
-      # @param state [String] Random security value that must match throughout the user's flow.
-      # It can be set to the value of your choice (preferably something random). You should verify it matches the expected value when validating the OAuth callback.
-      def oauth_url(state)
-        "#{self.oauth_end_point}/oauth/authorize?response_type=code&client_id=#{self.client_id}&state=#{state}"
-      end
-
-      # Retrieves the OAuth token
-      # @option opts [String] state Random security value that was used when you created oauth_url for a specific user.
-      # @option opts [String] code The code passed to your callback when the user granted access.
-      # @option opts [String] client_id The ApiApp Client ID.
-      # @option opts [String] client_secret The secret token of your ApiApp.
-      #
-      # @return [Hash] OAuth data of the user
-      #
-      # @example
-      #   client = HelloSign::Client.new(
-      #     api_key: '%apikey%',
-      #     client_id: 'cc91c61d00f8bb2ece1428035716b',
-      #     client_secret: '1d14434088507ffa390e6f5528465'
-      #   )
-      #   client.get_oauth_token(
-      #     state: '900e06e2',
-      #     code:'1b0d28d90c86c141'
-      #   )
-      def get_oauth_token(opts)
-        opts[:client_id] = self.client_id
-        opts[:client_secret] = self.client_secret
-        opts[:grant_type] = 'authorization_code'
-        post('/oauth/token', { body: opts, oauth_request: true })
-      end
-
-      # Refreshes the user's OAuth token.
-      # @option opts [String] refresh_token The token provided when the access token has expired.
-      #
-      # @return [Hash] Refreshed OAuth info
-      #
-      # @example
-      #   client.refresh_oauth_token refresh_token: 'hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3'
-      def refresh_oauth_token(opts)
-        opts[:client_id] = self.client_id
-        opts[:client_secret] = self.client_secret
-        opts[:grant_type] = 'refresh_token'
-        post('/oauth/token', { body: opts, oauth_request: true })
-      end
-
-      # Creates a new user and retrieves the OAuth token. The user will receive an email asking them to confirm the access being granted.
-      # Your app will not be able to perform actions on behalf of this user until they confirm.
-      # @option opts [String] email_address New user's email address.
-      #
-      # @return [Hash] details about new user, including OAuth data
-      #
-      # @example
-      #   client.oauth_create_account email_address: 'new_user@example.com'
-      def oauth_create_account(opts)
-        opts[:client_id] = self.client_id
-        opts[:client_secret] = self.client_secret
-
-        HelloSign::Resource::Account.new post('/account/create', { body: opts })
-      end
-    end
-  end
-end