hellosign-ruby-sdk 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9eaa58b2e89525020a5680a6bf6eec365b10dc92
-  data.tar.gz: 925c4320a41f696ca1f9cdb72ba7755c4c6e7386
+  metadata.gz: 89eec89ae4b017951803a46a453d361df0f189f9
+  data.tar.gz: 42724e068d0453de5d7dc7134a8bac16d7583894
 SHA512:
-  metadata.gz: fef29d6b444650087026074d2ab7bc9b24538917d4060dc0d7e8cd9e92df50e6f86c34a789e8a8f728c2a53f55a2c4793ba2afb8ebfe6ce6a4d03eaddde77d8f
-  data.tar.gz: 99cdacd9aa442dedd4bc02275b63b85910fa5ecdc7a1d0d7f75a4a71ec7d3372f80f69a8ddfffd91033a52e81cda22e9fa26deba7c86e6faf3ea0afb2fc28f0d
+  metadata.gz: a8fedacf35e41f2bcb43f8d2a42effa92ed9ca55e9fe23dd5e122ad5b33b4839ec51648def64465d62cb32c8b34c4abb7cc07464b742e43838651ce1ba1a8561
+  data.tar.gz: f4eaceb5c880f4525caa584e020d74cd202127160d1f9d85714a7617ea86822063a7aff88ad58dfa5ac116a56f6d3617c10abe4922fa75bebd3ae0355855dfbe

data/lib/hello_sign/api.rb

@@ -1,8 +1,8 @@
 #
 # 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
@@ -29,3 +29,4 @@ require 'hello_sign/api/signature_request'
 require 'hello_sign/api/team'
 require 'hello_sign/api/unclaimed_draft'
 require 'hello_sign/api/oauth'
+require 'hello_sign/api/api_app'

data/lib/hello_sign/api/api_app.rb

@@ -0,0 +1,114 @@
+#
+# 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 {https://www.hellosign.com/api/reference#Team team api document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    module ApiApp
+
+      #
+      # Retrieves information about a specific API App by a given ID
+      #
+      # @return [HelloSign::Resource::ApiApp] the API App
+      #
+      # @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 you currently have access to on your account
+      # @option opts [Integer] page (1) Which page number of the list to return.
+      # @option opts [Integer] page_size (5) Number of results for each page
+      #
+      # @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 API Application on your account
+      # @option opts [String] name The name you want to assign to the ApiApp.
+      # @option opts [String] domain The domain name the ApiApp will be associated with.
+      # @option opts [String] callback_url (optional) The URL at which the ApiApp should receive event callbacks.
+      # @option opts [String] custom_logo_file (optional) An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
+      # @option opts [String] oauth[callback_url] (optional) The callback URL to be used for OAuth flows. (Required if oauth[scopes] is provided)
+      # @option opts [String] oauth[scopes] (optional) A comma-separated list of OAuth scopes to be granted to the app. (Required if oauth[callback_url] is provided)
+      #
+      # @return [HelloSign::Resource::ApiApp] newly created ApiApp object
+      #
+      # @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 parameters for a specific API Application on your account, referenced by ID
+      # @oprion opts [String] client_id (REQUIRED) The ID of the app you want to update
+      # @option opts [String] name (optional) The name you want to assign to the ApiApp.
+      # @option opts [String] domain (optional) The domain name the ApiApp will be associated with.
+      # @option opts [String] callback_url (optional) The URL at which the ApiApp should receive event callbacks.
+      # @option opts [String] custom_logo_file (optional) An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
+      # @option opts [String] oauth[callback_url] (optional) The callback URL to be used for OAuth flows. (Required if oauth[scopes] is provided)
+      # @option opts [String] oauth[scopes] (optional) A comma-separated list of OAuth scopes to be granted to the app. (Required if oauth[callback_url] is provided)
+      #
+      # @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 put(path, :body => opts)
+      end
+
+      #
+      # Deletes an API App. Can only be invoked for apps you own.
+      #
+      # @example
+      #   result = @client.delete_api_app :client_id => 'hdialuhfilaudshfa'
+      def delete_api_app(opts)
+        path = '/api_app/' + opts[:client_id]
+        delete(path)
+      end
+    end
+  end
+end

data/lib/hello_sign/client.rb

@@ -49,6 +49,7 @@ module HelloSign
     include Api::UnclaimedDraft
     include Api::Embedded
     include Api::OAuth
+    include Api::ApiApp
 
     attr_accessor :end_point, :oauth_end_point, :api_version, :user_agent, :client_id, :client_secret, :email_address, :password, :api_key, :auth_token, :logging, :log_level
 

data/lib/hello_sign/resource.rb

@@ -1,8 +1,8 @@
 #
 # 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
@@ -31,3 +31,4 @@ require 'hello_sign/resource/template'
 require 'hello_sign/resource/signature_request'
 require 'hello_sign/resource/team'
 require 'hello_sign/resource/unclaimed_draft'
+require 'hello_sign/resource/api_app'

data/lib/hello_sign/resource/api_app.rb

@@ -0,0 +1,48 @@
+#
+# The MIT License (MIT)
+#
+# Copyright (C) 2015 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 Resource
+
+    #
+    # Contains information about an team and its members.
+    # Take a look at our {https://www.hellosign.com/api/reference#ApiApp API Application resource document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    class ApiApp < BaseResource
+
+      #
+      # create a new ApiApp 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] API Application data
+      # @param  key [String] (api_app) key of the hash, point to where API application data is. If nil then the hash itself
+      #
+      # @return [HelloSign::Resource:ApiApp] an ApiApp resource
+      def initialize(hash, key='api_app')
+        super
+      end
+    end
+  end
+end

data/lib/hello_sign/version.rb

@@ -23,5 +23,5 @@
 #
 
 module HelloSign
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/spec/fixtures/api_app.json

@@ -0,0 +1,16 @@
+{
+
+  "api_app": {
+          "client_id" : "5e365c014bea2e9a05a9d0834f3e7ca4",
+         "created_at" : 1438030211,
+               "name" : "Hodor",
+             "domain" : "hodor.com",
+       "callback_url" : null,
+      "owner_account" : {
+             "account_id" : "626e28a7781d6d12bd830220488a45e9ef3378ab",
+          "email_address" : "hello@example.com"
+      },
+        "is_approved" : false,
+              "oauth" : null
+  }
+}

data/spec/fixtures/api_apps.json

@@ -0,0 +1,43 @@
+{
+    "api_apps": [
+        {
+            "callback_url": null,
+            "client_id": "0dd3b823a682527788c4e40cb7b6f7e9",
+            "created_at": 1436232339,
+            "domain": "example.com",
+            "is_approved": true,
+            "name": "My Production App",
+            "oauth": {
+                "callback_url": "http://example.com/oauth",
+                "scopes": [
+                    "basic_account_info",
+                    "request_signature"
+                ],
+                "secret": "98891a1b59f312d04cd88e4e0c498d75"
+            },
+            "owner_account": {
+                "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888",
+                "email_address": "john@example.com"
+            }
+        },
+        {
+            "callback_url": null,
+            "client_id": "bff6d867fafcca27554cf89b1ca98793",
+            "created_at": 1433458421,
+            "domain": "example.com",
+            "is_approved": false,
+            "name": "My Other App",
+            "oauth": null,
+            "owner_account": {
+                "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888",
+                "email_address": "john@example.com"
+            }
+        }
+    ],
+    "list_info": {
+        "num_pages": 1,
+        "num_results": 2,
+        "page": 1,
+        "page_size": 20
+    }
+}

data/spec/hello_sign/api/api_app_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe HelloSign::Api::ApiApp do
+
+  describe '#get_api_app' do
+    before do
+      stub_get('/api_app/5e365c014bea2e9a05a9d0834f3e7ca4', 'api_app')
+      @api_app = HelloSign.get_api_app :client_id => '5e365c014bea2e9a05a9d0834f3e7ca4'
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/api_app/5e365c014bea2e9a05a9d0834f3e7ca4')).to have_been_made
+    end
+
+    it 'should return current user account' do
+      expect(@api_app).to be_an HelloSign::Resource::ApiApp
+    end
+  end
+
+  describe '#list_api_apps' do
+    before do
+      stub_get('/api_app/list', 'api_apps')
+      @api_apps = HelloSign.get_api_apps({})
+    end
+
+    it 'should get the correct resource' do
+      expect(a_get('/api_app/list')).to have_been_made
+    end
+
+    it 'should return a Resource Array' do
+      expect(@api_apps).to be_an HelloSign::Resource::ResourceArray
+    end
+
+    it 'each of Array is an ApiApp' do
+      expect(@api_apps[0]).to be_an HelloSign::Resource::ApiApp
+    end
+  end
+
+  describe '#create_api_app' do
+    before do
+      stub_post('/api_app', 'api_app')
+      @api_app = HelloSign.create_api_app(
+        :name => 'Herbert App',
+        :domain => 'herbert.com'
+      )
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/api_app')).to have_been_made
+    end
+
+    it 'should return an ApiApp' do
+      expect(@api_app).to be_an HelloSign::Resource::ApiApp
+    end
+  end
+
+  describe '#update_api_app' do
+    before do
+      stub_put('/api_app/5e365c014bea2e9a05a9d0834f3e7ca4', 'api_app')
+      @api_app = HelloSign.update_api_app(
+        :client_id => '5e365c014bea2e9a05a9d0834f3e7ca4',
+        :name => 'Herbert App',
+        :domain => 'herbert.com'
+      )
+    end
+
+    it 'should get the correct resource' do
+      expect(a_put('/api_app/5e365c014bea2e9a05a9d0834f3e7ca4')).to have_been_made
+    end
+
+    it 'should return an ApiApp' do
+      expect(@api_app).to be_an HelloSign::Resource::ApiApp
+    end
+  end
+
+  describe '#delete_api_app' do
+    before do
+      stub_delete('/api_app/1', 'api_app')
+      @api_app = HelloSign.delete_api_app(:client_id => '1')
+    end
+
+    it 'should get the correct resource' do
+      expect(a_delete('/api_app/1')).to have_been_made
+    end
+  end
+
+end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: hellosign-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - HelloSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-07-27 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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: ''
@@ -114,9 +114,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
@@ -127,6 +127,7 @@ files:
 - lib/hello_sign.rb
 - lib/hello_sign/api.rb
 - lib/hello_sign/api/account.rb
+- lib/hello_sign/api/api_app.rb
 - lib/hello_sign/api/embedded.rb
 - lib/hello_sign/api/oauth.rb
 - lib/hello_sign/api/signature_request.rb
@@ -138,6 +139,7 @@ files:
 - 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/embedded.rb
 - lib/hello_sign/resource/resource_array.rb
@@ -148,6 +150,8 @@ files:
 - lib/hello_sign/resource/unclaimed_draft.rb
 - lib/hello_sign/version.rb
 - spec/fixtures/account.json
+- spec/fixtures/api_app.json
+- spec/fixtures/api_apps.json
 - spec/fixtures/embedded.json
 - spec/fixtures/empty.pdf
 - spec/fixtures/error.json
@@ -161,6 +165,7 @@ files:
 - spec/fixtures/token.json
 - spec/fixtures/unclaimed_draft.json
 - spec/hello_sign/api/account_spec.rb
+- spec/hello_sign/api/api_app_spec.rb
 - spec/hello_sign/api/embedded_spec.rb
 - spec/hello_sign/api/oauth_spec.rb
 - spec/hello_sign/api/signature_request_spec.rb
@@ -182,22 +187,24 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.0.14
 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/embedded.json
 - spec/fixtures/empty.pdf
 - spec/fixtures/error.json
@@ -211,6 +218,7 @@ test_files:
 - spec/fixtures/token.json
 - spec/fixtures/unclaimed_draft.json
 - spec/hello_sign/api/account_spec.rb
+- spec/hello_sign/api/api_app_spec.rb
 - spec/hello_sign/api/embedded_spec.rb
 - spec/hello_sign/api/oauth_spec.rb
 - spec/hello_sign/api/signature_request_spec.rb