egree 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d312dc980ab9ce2ef80fc6dd3ff8cfe1b18ff149
-  data.tar.gz: 76b01dd7a7d5f556dc6917df58c6dd56df7ee29a
+  metadata.gz: 3309501f588e8dacabdf2efe9bfe4dc04cb18fbd
+  data.tar.gz: d0ea6cb7fe2cc29187ccf7d7218f5523be2fd540
 SHA512:
-  metadata.gz: 4bf175c5c2d84ede2932be4238a83c98a0e7b21af52e3e5f14f7c760078aa2f35d6b3a69dfac6ccd25b27b4d906c2c021d7308451fc2aadc3858b6a5a6c4e131
-  data.tar.gz: f63183fa1383fd85b77c1159f53ad8cdeb8f8bc3ce87aac0cffc4100c3db738156b8810054d4a4b9aa7680905bded9cdab21dd712cb4a2facc90383b517cb90e
+  metadata.gz: 9bae1e3739e8f9971d0a4fab40bd03cc09ac91c89582ca60e73478b06718c967bf0a5235a186d0a1493d1339e97bb628c94ff47a97f83de0b50d6217c14edf03
+  data.tar.gz: 320d11f49ac518c460e3c61517198cc5c2110ae4d1bc66a8512498bd7433d7c0768db2b218bdeb44b9f4bfcc878edf5f394656912c625e99f7805fcb40ff07c7

data/README.md

@@ -1,73 +1,78 @@
 [![Build Status](https://travis-ci.org/joeljunstrom/egree-ruby.svg?branch=master)](https://travis-ci.org/joeljunstrom/egree-ruby)
 [![Code Climate](https://codeclimate.com/github/joeljunstrom/egree-ruby/badges/gpa.svg)](https://codeclimate.com/github/joeljunstrom/egree-ruby)
 [![Test Coverage](https://codeclimate.com/github/joeljunstrom/egree-ruby/badges/coverage.svg)](https://codeclimate.com/github/joeljunstrom/egree-ruby)
+[![Gem Version](https://badge.fury.io/rb/egree.svg)](http://badge.fury.io/rb/egree)
 
 # Egree
 
 Ruby client for the [Egree API](https://app.egree.com/apiv1).
 
-Currently the only supported actions is the `createcasecommand` and `getviewcaseurlquery`.
+Currently the only supported api calls is `createcasecommand` and `getviewcaseurlquery`.
 
 ## Usage
 
 ### Creating a case
 
-```
-  egree = Egree.client username, password
-
-  signature_case = Egree::Case.new "Agreement", ["touch"]
-  signature_case.add_party Egree::Party.new({
-    name: "First Last",
-    email: "name@example.com",
-    social_security_number: "1234567890"
-  })
-  signature_case.add_document Egree::Document.new "/some/path/file.pdf"
-
-  result = egree.create_case signature_case
-
-  if result.success?
-	puts "#{signature_case.reference_id} was created."
-  else 
-	puts "There was some issues with the case"
-	result.errors.each do |error|
-      puts error
-	end
+```ruby
+egree = Egree.client username, password
+
+signature_case = Egree::Case.new "Agreement", ["touch"]
+signature_case.add_party Egree::Party.new_with_attributes({
+  name: "First Last",
+  email: "name@example.com",
+  social_security_number: "1234567890"
+})
+signature_case.add_document Egree::Document.new "/some/path/file.pdf"
+
+result = egree.create_case(signature_case, {
+  postback_url: "https://example.com/my-endpoint",
+  continue: {
+    url: "http://example.com/user-endpoint",
+    auto: true
+  }
+})
+
+if result.success?
+  puts "#{signature_case.reference_id} was created."
+else 
+  puts "There was some issues with the case"
+  result.errors.each do |error|
+    puts error
   end
+end
 ```
 
 ### Getting the signature url for a case
 
-```
-  egree = Egree.client username, password
-  result = egree.get_case_url "98d08cf5-d35d-403b-ac31-fa1ac85037a1"
-
-  if result.success?
-	puts "The url is: #{result.response}"
-  else
-	puts "Could not get signature url"
-	result.errors.each do |error|
-      puts error
-	end
+```ruby
+egree = Egree.client username, password
+result = egree.get_case_url "98d08cf5-d35d-403b-ac31-fa1ac85037a1"
+
+if result.success?
+  puts "The url is: #{result.response}"
+else
+  puts "Could not get signature url"
+  result.errors.each do |error|
+    puts error
   end
+end
 ```
   
 
 
 ## Contributing
 
-1. Fork it ( http://github.com/joeljunstrom/egree/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Contributions is more than welcome!
+
+Just create a fork and submit a pull request.
+
+Please adhere to the coding standards used in the project and add tests.
 
 ### Local development
 
-Create a .env file in the root directory.
+Create a .env file in the root directory to run the integration tests against your Egree environment.
 
-```
+```yaml
 EGREE_USERNAME=your-username
 EGREE_PASSWORD=your-password
 ```
-
-This is used for the integration tests.

data/lib/egree/api_mappers/case_options_mapper.rb

@@ -0,0 +1,36 @@
+module Egree
+  module ApiMappers
+    module CaseOptionsMapper
+      def self.to_api options = {}, mappers = self.mappers
+        options.reduce({}) do |api_hash, (client_key, value)|
+          if mappers.key?(client_key)
+            api_hash.merge(self.map(client_key, value, mappers))
+          else
+            api_hash
+          end
+        end || {}
+      end
+
+      private
+
+      def self.map client_key, value, mappers = self.mappers
+        mapper = mappers[client_key]
+
+        if mapper.respond_to?(:call)
+          mapper.call value
+        else
+          { mapper => value }
+        end
+      end
+
+      def self.mappers
+        {
+          postback_url: "CaseFinishedCallbackUrl",
+          continue: ->(options) {
+            CaseOptionsMapper.to_api options, name: "ContinueName", url: "ContinueUrl", auto: "ContinueAuto"
+          }
+        }
+      end
+    end
+  end
+end

data/lib/egree/client.rb

@@ -16,8 +16,8 @@ module Egree
       self.environment = environment
     end
 
-    def create_case signature_case
-      signature_case_json = Egree::Serializers::CaseSerializer.serialize signature_case
+    def create_case signature_case, options = {}
+      signature_case_json = Egree::Serializers::CaseSerializer.serialize signature_case, options
       post "/apiv1/createcasecommand", signature_case_json
     end
 

data/lib/egree/serializers/case_serializer.rb

@@ -4,8 +4,10 @@ require "egree/api_mappers/case_mapper"
 module Egree
   module Serializers
     module CaseSerializer
-      def self.serialize signature_case
-        JSON.pretty_generate Egree::ApiMappers::CaseMapper.to_api(signature_case)
+      def self.serialize signature_case, options = {}
+        signature_case_api_hash = Egree::ApiMappers::CaseMapper.to_api signature_case
+        options_api_hash = Egree::ApiMappers::CaseOptionsMapper.to_api options
+        JSON.pretty_generate signature_case_api_hash.merge(options_api_hash)
       end
     end
   end

data/lib/egree/version.rb

@@ -1,3 +1,3 @@
 module Egree
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/egree/api_mappers/case_options_mapper_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+require "egree/api_mappers/case_options_mapper"
+
+module Egree
+  module ApiMappers
+    RSpec.describe CaseOptionsMapper do
+      describe "#to_api" do
+        it "translates postback_url to CaseFinishedCallbackUrl" do
+          expect(CaseOptionsMapper.to_api(postback_url: "http://example.com")).to eq({
+            "CaseFinishedCallbackUrl" => "http://example.com"
+          })
+        end
+
+        describe "continue" do
+          it "translates name" do
+            options = { continue: { name: "The label" } }
+
+            expect(CaseOptionsMapper.to_api(options)).to eq({
+              "ContinueName" => "The label"
+            })
+          end
+
+          it "translates url" do
+            options = { continue: { url: "http://example.com/where-to-go" } }
+
+            expect(CaseOptionsMapper.to_api(options)).to eq({
+              "ContinueUrl" => "http://example.com/where-to-go"
+            })
+          end
+
+          it "translates auto" do
+            options = { continue: { auto: true } }
+
+            expect(CaseOptionsMapper.to_api(options)).to eq({
+              "ContinueAuto" => true
+            })
+          end
+        end
+
+        it "ignores unknown keys" do
+          expect(CaseOptionsMapper.to_api({
+            postback_url: "http://example.com",
+            unknown: "Some value"
+          })).to eq({
+            "CaseFinishedCallbackUrl" => "http://example.com"
+          })
+        end
+      end
+    end
+  end
+end

data/spec/egree/api_mappers/reference_id_mapper_spec.rb

@@ -12,7 +12,6 @@ module Egree
         expect(ReferenceIdMapper.to_api(reference_id)).to eq({
           "CaseReferenceId" => "123"
         })
-
       end
     end
   end

data/spec/egree/client/create_case_spec.rb

@@ -17,10 +17,11 @@ module Egree
         allow(client).to receive :post
 
         signature_case = double "Case"
+        options = { postback_url: "http://example.com/postback" }
 
-        expect(Egree::Serializers::CaseSerializer).to receive(:serialize).with(signature_case).and_return "case-json"
+        expect(Egree::Serializers::CaseSerializer).to receive(:serialize).with(signature_case, options).and_return "case-json"
 
-        client.create_case signature_case
+        client.create_case signature_case, options
 
         expect(client).to have_received(:post).with "/apiv1/createcasecommand", "case-json"
       end

data/spec/egree/serializers/case_serializer_spec.rb

@@ -15,6 +15,18 @@ module Egree
 
           expect(CaseSerializer.serialize(signature_case)).to eq JSON.pretty_generate(api_hash)
         end
+
+        it "takes options for how to handle the user" do
+          signature_case = double "Egree::Case"
+          api_hash = { "The" => "Case" }
+          options = { postback_url: "http://example.com" }
+          options_hash = { "CaseFinishedCallbackUrl" => "http://example.com" }
+
+          expect(Egree::ApiMappers::CaseMapper).to receive(:to_api).with(signature_case).and_return api_hash
+          expect(Egree::ApiMappers::CaseOptionsMapper).to receive(:to_api).with(options).and_return options_hash
+
+          expect(CaseSerializer.serialize(signature_case, options)).to eq JSON.pretty_generate(api_hash.merge(options_hash))
+        end
       end
     end
   end

data/spec/egree_spec.rb

@@ -3,7 +3,7 @@ require "egree"
 
 RSpec.describe Egree do
   describe ".client" do
-    it "creates a Egree::Client" do
+    it "returns a Egree::Client" do
       expect(Egree.client("admin", "secret")).to be_kind_of Egree::Client
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: egree
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Joel Junström
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,6 +139,7 @@ files:
 - egree.gemspec
 - lib/egree.rb
 - lib/egree/api_mappers/case_mapper.rb
+- lib/egree/api_mappers/case_options_mapper.rb
 - lib/egree/api_mappers/document_mapper.rb
 - lib/egree/api_mappers/form_field_mapper.rb
 - lib/egree/api_mappers/party_mapper.rb
@@ -153,6 +154,7 @@ files:
 - lib/egree/serializers/reference_id_serializer.rb
 - lib/egree/version.rb
 - spec/egree/api_mappers/case_mapper_spec.rb
+- spec/egree/api_mappers/case_options_mapper_spec.rb
 - spec/egree/api_mappers/document_mapper_spec.rb
 - spec/egree/api_mappers/form_field_mapper_spec.rb
 - spec/egree/api_mappers/party_mapper_spec.rb
@@ -201,6 +203,7 @@ specification_version: 4
 summary: Client for the Egree API
 test_files:
 - spec/egree/api_mappers/case_mapper_spec.rb
+- spec/egree/api_mappers/case_options_mapper_spec.rb
 - spec/egree/api_mappers/document_mapper_spec.rb
 - spec/egree/api_mappers/form_field_mapper_spec.rb
 - spec/egree/api_mappers/party_mapper_spec.rb