rightsignature 0.1.3 → 0.1.4

data/README.md

@@ -8,7 +8,7 @@ gem install rightsignature
 ```
 or in your Gemfile
 ```
-gem 'rightsignature', '~> 0.1.2'
+gem 'rightsignature', '~> 0.1.4'
 ```
 
 Setup
@@ -330,6 +330,28 @@ RightSignature::Template.generate_build_url(options)
 ```
 
 
+Account
+---------
+API calls involving API user's account.
+
+#####User Details
+```
+RightSignature::Account.user_details
+```
+
+#####Add User to Account
+```
+RightSignature::Account.add_user(name, email)
+```
+
+#####Usage Report
+Returns number of documents sent. Can scope to week, month, or day and count only signed, unsigned, or all documents.
+```
+RightSignature::Account.usage_report(since=nil, signed=nil)
+```
+* since: Only count documents sent withing the 'week', 'month', or 'day'.
+* signed: Only count signed documents if 'true', else all documents
+
 Custom API calls using RightSignature::Connection
 -------------------------------------------------
 
@@ -359,4 +381,5 @@ $:.push File.expand_path("../lib", __FILE__); require "rightsignature"; RightSig
 
 TODO:
 -----
+* Parse error message from response body on unsuccessful requests
 * Have a way for to generate an OAuth Access Token from RightSignature

data/lib/rightsignature.rb

@@ -5,6 +5,7 @@ require 'rightsignature/errors'
 require 'rightsignature/helpers/normalizing'
 require 'rightsignature/document'
 require 'rightsignature/template'
+require 'rightsignature/account'
 require 'rightsignature/connection/oauth_connection'
 require 'rightsignature/connection/token_connection'
 require 'rightsignature/connection'

data/lib/rightsignature/account.rb

@@ -0,0 +1,20 @@
+module RightSignature
+  class Account
+    class <<self
+      def user_details
+        RightSignature::Connection.get "/api/users/user_details.xml"
+      end
+      
+      def add_user(name, email)
+        RightSignature::Connection.post "/api/users.xml", {:user => {:name => name, :email => email}}
+      end
+      
+      def usage_report(since=nil, signed=nil)
+        options = {}
+        options[:since] = since if since && ["month", "week", "day"].include?(since)
+        options[:signed] = signed.to_s unless signed.nil?
+        RightSignature::Connection.get "/api/account/usage_report.xml", options
+      end
+    end
+  end
+end

data/lib/rightsignature/version.rb

@@ -1,3 +1,3 @@
 module RightSignature
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/account_spec.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RightSignature::Account do
+  describe "user_details" do
+    it "should GET /api/users/user_details.xml" do
+      RightSignature::Connection.should_receive(:get).with('/api/users/user_details.xml')
+      RightSignature::Account.user_details
+    end
+  end
+
+  describe "add_user" do
+    it "should POST /api/users.xml with user email and name in hash" do
+      RightSignature::Connection.should_receive(:post).with('/api/users.xml', {:user => {:name => "Jimmy Cricket", :email => "jimmy@example.com"}})
+      RightSignature::Account.add_user("Jimmy Cricket", "jimmy@example.com")
+    end
+  end
+  
+  describe "usage_report" do
+    it "should GET /api/account/usage_report.xml" do
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {})
+      RightSignature::Account.usage_report
+    end
+
+    it "should GET /api/account/usage_report.xml with acceptable param for :since" do
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {:since => "week"})
+      RightSignature::Account.usage_report("week")
+
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {:since => "month"})
+      RightSignature::Account.usage_report("month")
+
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {:since => "day"})
+      RightSignature::Account.usage_report("day")
+
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {})
+      RightSignature::Account.usage_report("1/4/90")
+    end
+    
+    it "should GET /api/account/usage_report.xml with param :signed" do
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {:signed => "true"})
+      RightSignature::Account.usage_report(nil, true)
+
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {:signed => "false"})
+      RightSignature::Account.usage_report(nil, false)
+    end
+
+    it "should GET /api/account/usage_report.xml with params :since and :signed" do
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {:signed => "true"})
+      RightSignature::Account.usage_report(nil, true)
+
+      RightSignature::Connection.should_receive(:get).with('/api/account/usage_report.xml', {:signed => "false"})
+      RightSignature::Account.usage_report(nil, false)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rightsignature
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -120,6 +120,7 @@ files:
 - Gemfile
 - README.md
 - lib/rightsignature.rb
+- lib/rightsignature/account.rb
 - lib/rightsignature/connection.rb
 - lib/rightsignature/connection/oauth_connection.rb
 - lib/rightsignature/connection/token_connection.rb
@@ -129,6 +130,7 @@ files:
 - lib/rightsignature/template.rb
 - lib/rightsignature/version.rb
 - rightsignature-api.gemspec
+- spec/account_spec.rb
 - spec/api_token_connection_spec.rb
 - spec/configuration_spec.rb
 - spec/connection_spec.rb