signatureio 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in signatureio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Scott Motte
+
+MIT License
+
+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,48 @@
+# Signatureio Ruby Bindings
+
+This gem is a wrapper for Signature.io's API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'signatureio'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install signatureio
+
+Then in your application initialize the gem:
+
+    $ Signatureio.secret_api_key = "your_secret_api_key"
+    $ Signatureio.public_api_key = "your_public_api_key"
+
+## Usage
+
+### Create Document
+
+    $ Signatureio::Document.create(:url => "https://www.signature.io/pdfs/sign-below.pdf")
+
+Replace the url with a url of the PDF or Microsoft Word file you choose.
+
+### Retrieve Document
+
+    $ Signatureio::Document.retrieve("id_of_document")
+
+### List Documents
+
+    $ Signatureio::Document.all
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. export SIGNATURE_SECRET_API_KEY="your_secret_api_key"
+4. export SIGNATURE_PUBLIC_API_KEY="your_public_api_key"
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/signatureio/document.rb

@@ -0,0 +1,21 @@
+module Signatureio
+  class Document
+    # 
+    # Api calls
+    # 
+    def self.create(attrs={})
+      response = Signatureio.request.post "documents.json", attrs
+      response.body.to_ostruct_recursive
+    end
+
+    def self.retrieve(id=nil)
+      response = Signatureio.request.get "documents/#{id}.json"
+      response.body.to_ostruct_recursive
+    end
+
+    def self.all
+      response = Signatureio.request.get "documents.json"
+      response.body.to_ostruct_recursive
+    end
+  end
+end

data/lib/signatureio/extensions/recursive_openstruct.rb

@@ -0,0 +1,28 @@
+# https://gist.github.com/2710460
+class Hash
+  # options:
+  #   :exclude => [keys] - keys need to be symbols 
+  def to_ostruct_recursive(options = {})
+    convert_to_ostruct_recursive(self, options) 
+  end
+
+  def with_sym_keys
+    self.inject({}) { |memo, (k,v)| memo[k.to_sym] = v; memo }
+  end
+
+  private
+
+  def convert_to_ostruct_recursive(obj, options)
+    result = obj
+    if result.is_a? Hash
+      result = result.dup.with_sym_keys
+      result.each  do |key, val| 
+        result[key] = convert_to_ostruct_recursive(val, options) unless options[:exclude].try(:include?, key)
+      end
+      result = OpenStruct.new result       
+    elsif result.is_a? Array
+       result = result.map { |r| convert_to_ostruct_recursive(r, options) }
+    end
+    return result
+  end
+end

data/lib/signatureio/extensions/try.rb

@@ -0,0 +1,57 @@
+class Object
+  # Invokes the method identified by the symbol +method+, passing it any arguments
+  # and/or the block specified, just like the regular Ruby <tt>Object#send</tt> does.
+  #
+  # *Unlike* that method however, a +NoMethodError+ exception will *not* be raised
+  # and +nil+ will be returned instead, if the receiving object is a +nil+ object or NilClass.
+  #
+  # If try is called without a method to call, it will yield any given block with the object.
+  #
+  # Please also note that +try+ is defined on +Object+, therefore it won't work with
+  # subclasses of +BasicObject+. For example, using try with +SimpleDelegator+ will
+  # delegate +try+ to target instead of calling it on delegator itself.
+  #
+  # ==== Examples
+  #
+  # Without +try+
+  #   @person && @person.name
+  # or
+  #   @person ? @person.name : nil
+  #
+  # With +try+
+  #   @person.try(:name)
+  #
+  # +try+ also accepts arguments and/or a block, for the method it is trying
+  #   Person.try(:find, 1)
+  #   @people.try(:collect) {|p| p.name}
+  #
+  # Without a method argument try will yield to the block unless the receiver is nil.
+  #   @person.try { |p| "#{p.first_name} #{p.last_name}" }
+  #--
+  # +try+ behaves like +Object#send+, unless called on +NilClass+.
+  def try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      __send__(*a, &b)
+    end
+  end
+end
+
+class NilClass
+  # Calling +try+ on +nil+ always returns +nil+.
+  # It becomes specially helpful when navigating through associations that may return +nil+.
+  #
+  # === Examples
+  #
+  #   nil.try(:name) # => nil
+  #
+  # Without +try+
+  #   @person && !@person.children.blank? && @person.children.first.name
+  #
+  # With +try+
+  #   @person.try(:children).try(:first).try(:name)
+  def try(*args)
+    nil
+  end
+end

data/lib/signatureio/version.rb

@@ -0,0 +1,3 @@
+module Signatureio
+  VERSION = "0.0.1"
+end

data/lib/signatureio.rb

@@ -0,0 +1,76 @@
+require "faraday"
+require "faraday_middleware"
+require "signatureio/extensions/try"
+require "signatureio/extensions/recursive_openstruct"
+require "signatureio/version"
+require "signatureio/document"
+
+module Signatureio
+  extend self
+
+  def request=(request)
+    @request = request
+  end
+
+  def request
+    @request
+  end
+
+  def secret_api_key=(secret_api_key)
+    @secret_api_key = secret_api_key
+    setup_request!
+
+    @secret_api_key
+  end
+
+  def secret_api_key
+    return @secret_api_key if @secret_api_key
+    "missing_secret_api_key"
+  end
+
+  def public_api_key=(public_api_key)
+    @public_api_key = public_api_key
+    setup_request!
+
+    @public_api_key
+  end
+
+  def public_api_key
+    return @public_api_key if @public_api_key
+    "missing_public_api_key"
+  end
+
+  def api_version=(api_version)
+    @api_version = api_version
+    setup_request!
+
+    @api_version
+  end
+
+  def api_version
+    return @api_version if @api_version
+    0
+  end
+
+  def api_endpoint
+    ["https://www.signature.io/api/v", api_version].join
+  end
+
+  private
+
+  def setup_request!
+    options = {
+      headers:  {'Accept' => "application/json"},
+      ssl:      {:verify => false},
+      url:      Signatureio.api_endpoint
+    }
+
+    Signatureio.request = ::Faraday::Connection.new(options) do |builder|
+      builder.use     ::Faraday::Request::UrlEncoded
+      builder.use     ::FaradayMiddleware::ParseJson
+      builder.adapter ::Faraday.default_adapter
+    end
+
+    Signatureio.request.basic_auth(Signatureio.secret_api_key, '')
+  end
+end

data/signatureio.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'signatureio/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "signatureio"
+  gem.version       = Signatureio::VERSION
+  gem.authors       = ["scottmotte"]
+  gem.email         = ["scott@scottmotte.com"]
+  gem.description   = %q{This gem is a wrapper for Signature.io's API.}
+  gem.summary       = %q{Use this wrapper gem to query Signature.io's API, create signable documents, view signed documents, and more.}
+  gem.homepage      = "https://www.signature.io"
+
+  gem.add_development_dependency "faraday"
+  gem.add_development_dependency "faraday_middleware"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/signatureio/document_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Signatureio::Document do
+  let(:subject)   { Signatureio::Document }
+  let(:url)       { "https://www.signature.io/pdfs/sign-below.pdf" }
+
+  context "incorrect secret api key" do
+    before do
+      Signatureio.secret_api_key = "incorrect_secret_api_key"
+    end
+
+    describe "attempt .create" do
+      before do
+        @response = subject.create({:url => url})
+      end
+
+      it do
+        @response.success.should be_false
+        @response.error.message.should_not be_empty
+      end
+    end
+
+    describe "attempt .retrieve" do
+      before do
+        @response = subject.retrieve("1234")
+      end
+
+      it do
+        @response.success.should be_false
+        @response.error.message.should_not be_empty
+      end
+    end
+  end
+
+  context "correct secret api key" do
+    before do
+      set_secret_and_public_api_keys!
+    end
+
+    describe ".create" do
+      before do
+        @response = subject.create(attrs)
+      end
+
+      context "default" do
+        let(:attrs) { {:url => url} }
+
+        it do
+          @response.success.should be_true
+          @response.document.id.should_not be_empty
+        end
+      end
+
+      context "blank url" do
+        let(:attrs) { {:url => nil} }
+
+        it do 
+          @response.success.should be_false
+          @response.error.message.should_not be_empty
+        end
+      end
+
+      context "invalid url" do
+        let(:attrs) { {:url => "noexisturl"} }
+
+        it do 
+          @response.success.should be_false
+          @response.error.message.should_not be_empty
+        end
+      end
+    end
+
+    describe ".retrieve" do
+      before do
+        response = subject.create({:url => url})
+        @id = response.document.id
+      end
+
+      context "default" do
+        before do
+          @response = subject.retrieve(@id)
+        end
+        
+        it do
+          @response.success.should be_true
+          @response.document.id.should eq @id
+        end
+      end
+
+      context "incorrect id" do
+        before do
+          @response = subject.retrieve("1234")
+        end
+
+        it do
+          @response.success.should be_false
+          @response.error.message.should_not be_empty
+        end
+      end
+    end
+
+    describe ".all" do
+      before do
+        @response = subject.all
+      end
+
+      context "default" do
+        it do
+          @response.success.should be_true
+          @response.documents.count.should >= 1
+        end
+      end
+    end
+  end
+end

data/spec/signatureio/version_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Signatureio do
+  it { Signatureio::VERSION.should eq "0.0.1" }
+end

data/spec/signatureio_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Signatureio do
+  subject { Signatureio }
+
+  describe "defaults" do
+    before do
+      subject.secret_api_key  = nil 
+      subject.public_api_key  = nil
+      subject.api_version     = nil
+    end
+
+    it { subject.api_endpoint.should eq "https://www.signature.io/api/v0" }
+    it { subject.api_version.should eq 0 }
+    it { subject.secret_api_key.should eq "missing_secret_api_key" }
+    it { subject.public_api_key.should eq "missing_public_api_key" }
+  end
+
+  describe "setting values" do
+    let(:secret_api_key)  { "sk_1234" }
+    let(:public_api_key)  { "pk_5678" }
+    let(:api_version)     { 1 }
+
+    before do
+      subject.secret_api_key  = secret_api_key
+      subject.public_api_key  = public_api_key
+      subject.api_version     = api_version
+    end
+
+    it { subject.api_version.should eq api_version }
+    it { subject.public_api_key.should eq public_api_key }
+    it { subject.secret_api_key.should eq secret_api_key }
+    it { subject.api_endpoint.should eq "https://www.signature.io/api/v1" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+require 'signatureio'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    # FakeWeb.allow_net_connect = false
+    set_secret_and_public_api_keys!
+  end
+
+  # config.after(:suite) do
+  #   FakeWeb.allow_net_connect = true
+  # end
+end
+
+def set_secret_and_public_api_keys!
+  # These keys come form rspec@signature.io person.
+  Signatureio.secret_api_key = ENV['SIGNATURE_SECRET_API_KEY']
+  Signatureio.public_api_key = ENV['SIGNATURE_PUBLIC_API_KEY']
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: signatureio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- scottmotte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a wrapper for Signature.io's API.
+email:
+- scott@scottmotte.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/signatureio.rb
+- lib/signatureio/document.rb
+- lib/signatureio/extensions/recursive_openstruct.rb
+- lib/signatureio/extensions/try.rb
+- lib/signatureio/version.rb
+- signatureio.gemspec
+- spec/signatureio/document_spec.rb
+- spec/signatureio/version_spec.rb
+- spec/signatureio_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.signature.io
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3089883217917200588
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3089883217917200588
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Use this wrapper gem to query Signature.io's API, create signable documents,
+  view signed documents, and more.
+test_files:
+- spec/signatureio/document_spec.rb
+- spec/signatureio/version_spec.rb
+- spec/signatureio_spec.rb
+- spec/spec_helper.rb