signatureio 0.0.5 → 0.0.6

data/README.md

@@ -39,12 +39,17 @@ Replace the url with a url of the PDF or Microsoft Word file you choose.
 
     $ Signatureio::Document.all
 
+### List Events
+
+    $ Signatureio::Event.all
+    $ Signatureio::Event.all({count: 1, offset: 1, type: "document.created"})
+
 ## 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"
+3. export SIGNATURE_SECRET_API_KEY="your_test_secret_api_key"
+4. export SIGNATURE_PUBLIC_API_KEY="your_test_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/lib/signatureio/event.rb

@@ -0,0 +1,17 @@
+module Signatureio
+  class Event
+    # 
+    # Api calls
+    # 
+    def self.all(options={})
+      url = ["events.json?"]
+      url << "type=#{options[:type]}"     if options[:type]
+      url << "count=#{options[:count]}"   if options[:count]
+      url << "offset=#{options[:offset]}" if options[:offset]
+
+      url = url.join("&")
+      response = Signatureio.request.get url
+      RecursiveOpenStruct.new(response.body, :recurse_over_arrays => true)
+    end
+  end
+end

data/lib/signatureio/version.rb

@@ -1,3 +1,3 @@
 module Signatureio
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/signatureio.rb

@@ -3,6 +3,7 @@ require "faraday_middleware"
 require "recursive-open-struct"
 require "signatureio/version"
 require "signatureio/document"
+require "signatureio/event"
 
 module Signatureio
   extend self

data/spec/signatureio/document_spec.rb

@@ -34,7 +34,7 @@ describe Signatureio::Document do
 
   context "correct secret api key" do
     before do
-      Signatureio.secret_api_key = nil
+      Signatureio.secret_api_key = ENV['SIGNATURE_SECRET_API_KEY']
     end
 
     describe ".create" do

data/spec/signatureio/event_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Signatureio::Event do
+  let(:subject)   { Signatureio::Event }
+  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 .all" do
+      before do
+        @response = subject.all
+      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
+      Signatureio.secret_api_key = ENV['SIGNATURE_SECRET_API_KEY']
+    end
+
+    describe ".all" do
+      before do
+        @response = subject.all(options)
+      end
+
+      context "default" do
+        let(:options) { {} }
+
+        it do
+          @response.success.should be_true
+          @response.events.count.should >= 1
+        end
+      end
+
+      context "count of 1" do
+        let(:options) { {count: 1} }
+
+        it do
+          @response.success.should be_true
+          @response.events.count.should == 1
+        end
+      end
+
+      context "type" do
+        let(:options) { {type: "nonexistant.type"} }
+
+        it do
+          @response.success.should be_true
+          @response.events.count.should == 0
+        end
+      end
+
+      context "offset" do
+        let(:options) { {offset: 3} }
+
+        it do
+          @response.success.should be_true
+          @response.offset.should eq 3
+        end
+      end
+    end
+  end
+end

data/spec/signatureio/version_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signatureio
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-12 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,9 +122,11 @@ files:
 - Rakefile
 - lib/signatureio.rb
 - lib/signatureio/document.rb
+- lib/signatureio/event.rb
 - lib/signatureio/version.rb
 - signatureio.gemspec
 - spec/signatureio/document_spec.rb
+- spec/signatureio/event_spec.rb
 - spec/signatureio/version_spec.rb
 - spec/signatureio_spec.rb
 - spec/spec_helper.rb
@@ -142,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1445965729381535831
+      hash: -2307663304026184963
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -151,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1445965729381535831
+      hash: -2307663304026184963
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -161,6 +163,7 @@ summary: Signature.io is the easiest way to create signable documents online. Se
   https://www.signature.io for details.
 test_files:
 - spec/signatureio/document_spec.rb
+- spec/signatureio/event_spec.rb
 - spec/signatureio/version_spec.rb
 - spec/signatureio_spec.rb
 - spec/spec_helper.rb