signnow-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b06055e99370cf62de7dce20b653a01a098bb39b
+  data.tar.gz: 9ed58ce770ce2437ecb0f9410914716b7aec9ea9
+SHA512:
+  metadata.gz: 7880020a0c9dd24b52d5d22d3a03fed698cf36ddb3c7b7e373b8d9b23313ae42fee3aa45cfbbe37d1b352d7a683b2ea1a4775d54b6dc60b81d363cc18b0fe5d2
+  data.tar.gz: be414eb7985a9c1151ef47000e3ea434839ba34fe59c9e8e6af8b812fdb73fe4b998fd7d3312086cd21da4609c657340901548bdd67595adbb3eefd19f8ed907

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.html
+/.rvmrc
+.project
+.ruby-version
+.ruby-gemset
+/spec/integration/*
+/coverage/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rspec"
+gem "rake"
+gem "webmock"
+gem "pry"
+gem 'coveralls'

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2012 Andres Bravo
+Copyright (c) 2012 dkd Internet Service GmbH
+
+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.

data/README.md

@@ -0,0 +1,150 @@
+SignNow [![Build Status](https://secure.travis-ci.org/andresbravog/signnow-ruby.png)](https://travis-ci.org/andresbravog/signnow-ruby) [![Code Climate](https://codeclimate.com/github/andresbravog/signnow-ruby.png)](https://codeclimate.com/github/andresbravog/signnow-ruby) [![Coverage Status](https://coveralls.io/repos/andresbravog/signnow-ruby/badge.png)](https://coveralls.io/r/andresbravog/signnow-ruby)
+======
+
+This is a Ruby wrapper for SignNow's API.
+
+Documentation
+=====
+
+We use RubyDoc for documentation.
+
+Usage
+======
+
+First, you've to install the gem
+
+    gem install signnow
+
+and require it
+
+    require "signnow"
+
+and set up your api_key
+
+    Signnow.configure do |config|
+      config[:app_id] = "_your_application_app_id_",
+      config[:app_secret] = "_your_application_app_secret_"
+    end
+
+set the extra ```:use_test_env?``` config option to true if you want to use the [signnow test environment](https://eval.signnow.com)
+
+    Signnow.configure do |config|
+      config[:use_test_env?] = true
+    end
+
+Oauth
+=====
+
+*[SignNow oauth2 API documentation](https://signnow.atlassian.net/wiki/display/SAPI/REST+Endpoints#RESTEndpoints-POST/oauth2)*
+
+Redirecting the user to the authorize url, You need to provide a redirect url where you will get a code param.
+
+    # Redirect the user to the authorize url
+    redirect_to Signnow::Authentications::Oauth.authorize_url(redirect_uri: your_redirect_url)
+
+Process the code param in order to get user oauth credentials.
+
+    oauth_credentials = Signnow::Authentications::Oauth.authenticate(code: code)
+
+    =>
+    {
+      access_token: '_user_access_token_',
+      refresh_token: '_user_refresh_token',
+      token_type: 'bearer',
+      scope: '*',
+      last_login: 2013929273,
+      expires_in: 2013929273
+    }
+
+Store the access token credentials in order to use the Signnow API
+
+    Signnow::User.show(access_token: oauth_credentials.access_token)
+
+
+Users
+=====
+
+*[SignNow users API documentation](https://signnow.atlassian.net/wiki/display/SAPI/REST+Endpoints#RESTEndpoints-/user)*
+
+Creating a user:
+
+    user = Singnow::User.create(
+      email: 'yournewuser@email.com', # required
+      password: 'new_password', # required
+      first_name: 'john', # optional
+      last_name: 'doe', # optional
+    )
+
+Store the acess_token
+
+    token = user.access_token
+
+Generate a client with the access token
+
+    client = Signnow::Client.new(token)
+
+Showing a user:
+
+    client.perform! |token|
+      Singnow::User.show(access_token: token)
+    end
+
+
+Documents
+=====
+
+*[SignNow documents API documentation](https://signnow.atlassian.net/wiki/display/SAPI/REST+Endpoints#RESTEndpoints-/document)*
+
+List user documents:
+
+    client.perform! |token|
+      Singnow::Document.all(access_token: token)
+    end
+
+Show a document:
+
+    client.perform! |token|
+      Singnow::Document.show(id: 'document_id', access_token: token)
+    end
+
+Get a one time download link for a document:
+
+    link =
+      client.perform! |token|
+        Singnow::Document.download_link(id: 'document_id', access_token: token)
+      end
+
+
+Documentation
+=====
+
+*[SignNow developers page](https://developers.signnow.com)*
+
+*[SignNow API documentation](https://signnow.atlassian.net/wiki/display/SAPI/REST+Endpoints)*
+
+
+Requirements
+=====
+
+This gem requires at least Ruby 1.9 and faces version 1 of SignNow's API.
+
+Bugs
+======
+
+Please report bugs at http://github.com/andresbravog/signnow-ruby/issues.
+
+Note on Patches/Pull Requests
+======
+
+* Fork the project from http://github.com/andresbravog/signnow-ruby.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+======
+
+Copyright (c) 2012-2013 andresbravog Internet Service GmbH, Andres Bravo. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/lib/signnow.rb

@@ -0,0 +1,119 @@
+require "net/http"
+require "net/https"
+require "json"
+require "signnow/version"
+require 'base64'
+
+module Signnow
+  DOMAIN_BASE = 'api'
+  TEST_DOMAIN_BASE = 'capi-eval'
+  API_BASE    = 'signnow.com'
+  API_BASE_PATH = nil
+  TEST_API_BASE_PATH = 'api'
+  API_VERSION = 'v1'
+  ROOT_PATH   = File.dirname(__FILE__)
+
+  @@configuration = {}
+
+  autoload :Base,           "signnow/base"
+  autoload :User,           "signnow/user"
+  autoload :Document,       "signnow/document"
+  autoload :Client,         "signnow/client"
+
+  module Authentications
+    autoload :Base,   "signnow/authentications/base"
+    autoload :Oauth,  "signnow/authentications/oauth"
+  end
+
+  module Operations
+    autoload :All,    "signnow/operations/all"
+    autoload :Create, "signnow/operations/create"
+    autoload :Delete, "signnow/operations/delete"
+    autoload :Find,   "signnow/operations/find"
+    autoload :Show,   "signnow/operations/show"
+    autoload :DownloadLink,   "signnow/operations/download_link"
+    autoload :Update, "signnow/operations/update"
+  end
+
+  module Request
+    autoload :Base,       "signnow/request/base"
+    autoload :Connection, "signnow/request/connection"
+    autoload :Helpers,    "signnow/request/helpers"
+    autoload :Info,       "signnow/request/info"
+    autoload :Validator,  "signnow/request/validator"
+  end
+
+  class SignnowError < StandardError; end
+  class AuthenticationError < SignnowError; end
+  class APIError            < SignnowError; end
+  class NotFound            < SignnowError; end
+  class InvalidToken        < APIError; end
+  class EmptyDocuments        < APIError; end
+
+  # Returns the set api key
+  #
+  # @return [String] The api key
+  def self.encoded_app_credentials
+    return unless configuration[:app_id] && configuration[:app_secret]
+    configuration[:encoded_app_credentials] ||=
+      Base64.strict_encode64("#{configuration[:app_id]}:#{configuration[:app_secret]}")
+  end
+
+  # Use thisfunciotn with a block to add app credentials configuration
+  # Example:
+  #
+  # Signnow.configure do |config|
+  #   config[:app_id] = 'your_app_id'
+  #   config[:app_secret] = 'your_app_secret'
+  # end
+  def self.configure
+    return unless block_given?
+    yield(configuration)
+  end
+
+  # Returns configuration hash
+  # @return [Hash]
+  def self.configuration
+    @@configuration
+  end
+
+  # Makes a request against the Signnow API
+  #
+  # @param [Symbol] http_method The http method to use, must be one of :get, :post, :put and :delete
+  # @param [String] domain The API domain to use
+  # @param [String] api_url The API url to use
+  # @param [Hash] data The data to send, e.g. used when creating new objects.
+  # @return [Array] The parsed JSON response.
+  def self.request(http_method, domain, api_url, data, options={})
+    info = Request::Info.new(http_method, domain, api_url, data, options)
+    Request::Base.new(info).perform
+  end
+
+  # Returns the domain base of the api depending on the env
+  #
+  def self.domain
+    if configuration[:use_test_env?]
+      TEST_DOMAIN_BASE
+    else
+      DOMAIN_BASE
+    end
+  end
+
+  # Returns the api base path depending on the env
+  #
+  def self.base_path
+    if configuration[:use_test_env?]
+      TEST_API_BASE_PATH
+    else
+      API_BASE_PATH
+    end
+  end
+
+  # Returns the api uri
+  #
+  def self.uri
+    uri = "https://#{domain}"
+    base_path && uri += "/#{base_path}"
+    uri
+  end
+end

data/lib/signnow/authentications/base.rb

@@ -0,0 +1,57 @@
+module Signnow
+  module Authentications
+    class Base
+      class << self
+        # Retrieves an oauth token from the Signnow API
+        #
+        # @param [Hash] attributes Attributes to pass to the API
+        # @return [Array] The available objects
+        def authenticate(attributes = {})
+          response = Signnow.request(
+            :post,
+            nil,
+            self.api_authenticate_url,
+            attributes_for_authentication(attributes),
+            options_for_authentication.merge(
+              use_form_data: true
+            )
+          )
+          self.new(response)
+        end
+
+        protected
+
+        # URl for the authenticate endpoint
+        # overwrite this in the model if the api is not well named
+        #
+        def api_authenticate_url
+          "#{self.name.split("::").last.downcase}"
+        end
+
+        # Options for the authentication mehtod
+        #
+        # @return [Hash]
+        def options_for_authentication
+          { auth_type: :basic }
+        end
+
+        # Attributes for the authentication mehtod
+        # overwrite this in the class to add attributes
+        #
+        # @param [Hash] attributes to merge with
+        # @return [Hash]
+        def attributes_for_authentication(attributes={})
+          {}.merge(attributes)
+        end
+
+        def domain
+          if Signnow.configuration[:use_test_env?]
+            'eval'
+          else
+            'www'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/signnow/authentications/oauth.rb

@@ -0,0 +1,68 @@
+module Signnow
+  module Authentications
+    class Oauth < Base
+      include Signnow::Operations::Create
+
+      attr_accessor :created, :access_token, :token_type, :expires_in,
+        :refresh_token, :scope, :last_login
+
+      class << self
+        # Returns the redirect url to authorize
+        #
+        # @param [Hash] options
+        # @option options [String] redirect_url () redirect url to receive the code param
+        def authorize_url(options = {})
+          protocol = "https"
+          base_url = "#{protocol}://#{domain}.#{API_BASE}"
+          path = "/proxy/index.php/authorize"
+          params = {
+            client_id: Signnow.configuration[:app_id],
+            redirect_uri: options[:redirect_uri],
+            response_type: 'code'
+          }
+
+          "#{base_url}#{path}?#{URI.encode_www_form(params)}"
+        end
+
+        protected
+
+        def api_authenticate_url
+          "oauth2/token"
+        end
+
+        # Attributes for the authentication mehtod
+        # overwrite this in the class to add attributes
+        #
+        # @param [Hash] attributes to merge with
+        # @return [Hash]
+        def attributes_for_authentication(attributes={})
+          { grant_type: 'authorization_code' }.merge(attributes)
+        end
+      end
+
+      # Initializes the object using the given attributes
+      #
+      # @param [Hash] attributes The attributes to use for initialization
+      def initialize(attributes = {})
+        set_attributes(attributes)
+        parse_timestamps
+      end
+
+      # Sets the attributes
+      #
+      # @param [Hash] attributes The attributes to initialize
+      def set_attributes(attributes)
+        attributes.each_pair do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # Parses UNIX timestamps and creates Time objects.
+      def parse_timestamps
+        @created = Time.at(created.to_i) if created
+        @expires_in = Time.at(expires_in.to_i) if expires_in
+        @last_login = Time.at(last_login.to_i) if last_login
+      end
+    end
+  end
+end