clicksign_ruby 1.0 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30813ecb47b7a24e1e4c1ababeee56fb2fcecb969f556671458e4a54e9e06724
-  data.tar.gz: 3ae5ce33b7069e04f12bf88cfcb7d0bbb840db23726102c86d33f6160551c88f
+  metadata.gz: 4e7c34809bca4210d64472194e366903bcc533d9394703d16383a593805ce6ba
+  data.tar.gz: 56805867cdf5ff4c638600dece8497dca9b46efc9c07ebe5c8b7667904244da0
 SHA512:
-  metadata.gz: 3ce8d9abd48c71f809d7681ff1c8fb8a5398e6f5cca3437aa70f8c78ea02731815daf0c001b3a0f6f826d7740c2a1a537ae4fa3e506aa4f9b7d4283913f2cb24
-  data.tar.gz: e7b3ce4ee3ecea33adcfe2bb687c2ded600769df4fc61068b7e6f994ab835cac9cb37081d5a22ebade042400190d140f8745def49542bcd80383e6a8bae42755
+  metadata.gz: 861dcb3ada9ed345ecb96fb826c4c79fd1ae357c7304db11ddc307fc1d3362be2537d3b12be01dd0d2aa57a21f2a9b9d48e980837316c02e79835d7f6abb5d28
+  data.tar.gz: 0133b37b3401753219f7417e776b26454d8b7b9f4aea1a4d6bddbacbc756dbc12898d51fe1813e52d4a11c767d4407d93c221880cbea3deb091c44bd53c3501a

data/README.md

@@ -8,7 +8,7 @@ Works on documentation version 2.0: Envelope
 With Bundler:
 
 ```
-gem 'clicksign', github: 'davi-canuto/clicksign-ruby', branch: 'main'
+gem 'clicksign_ruby'
 ```
 
 ## Usage
@@ -51,7 +51,7 @@ To upload a new document into Clicksign envelope you can use the following snipp
 ```ruby
 document = Clicksign::Document.new(@envelope_id).add({
   filename: '',
-  base64_content: "data:#{}\;base64,#{}"
+  content_base64: "data:#{}\;base64,#{}"
 })
 ```
 

data/clicksign.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Ruby library to interact with Clicksign}
   spec.summary       = %q{Ruby library to interact with Clicksign}
   spec.license       = 'MIT'
+  spec.homepage      = "https://github.com/davi-canuto/clicksign-ruby"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/examples/simple_api.rb

@@ -15,7 +15,7 @@ envelope_id = envelope['data']['id']
 document = Clicksign::Document.new(envelope_id).create(
   { 
     filename: 'samplename.jpg', 
-    base64_content: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJwAAACACAYAAAD+rACtAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAFeSURBVHhe7dIxAQAgDMCwgX/NwIOGXslTA13n3DsQ2b+QMBwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcMRmnltlQT6RDW/pgAAAABJRU5ErkJggg==", 
+    content_base64: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJwAAACACAYAAAD+rACtAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAFeSURBVHhe7dIxAQAgDMCwgX/NwIOGXslTA13n3DsQ2b+QMBwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcORMhwpw5EyHCnDkTIcKcMRmnltlQT6RDW/pgAAAABJRU5ErkJggg==", 
   }
 )
 

data/lib/clicksign/base.rb

@@ -22,13 +22,16 @@ module Clicksign
       JSON[response]
     end
 
-    def self.build_data(params, model_name, id='')
+    def self.build_data(params, model_name, id='', custom_params={})
       data = {
         data: {
           attributes: params,
           type: model_name
         }
       }
+      unless custom_params.empty?
+        data[:data].merge! custom_params
+      end
       unless id.empty?
         data[:data][:id] = id
       end

data/lib/clicksign/document.rb

@@ -10,10 +10,14 @@ module Clicksign
       @envelope_key = envelope_key
     end
 
+    def model_name
+      self.class.model_name
+    end
+
     def add params={}
       Base.request :post,
-        Base.api_url('envelopes', @envelope_key, Document.model_name),
-        Base.build_data(params, Document.model_name),
+        Base.api_url('envelopes', @envelope_key, model_name),
+        Base.build_data(params, model_name),
         {}
     end
   end

data/lib/clicksign/envelope.rb

@@ -11,26 +11,18 @@ module Clicksign
         {}
     end
 
-    def self.find key
-      request :get,
-        api_url(model_name, key),
-        {}
+    def initialize(envelope_key)
+      @envelope_key = envelope_key
     end
 
-    def self.update params={}, key
-      unless params[:data]&[:id]
-        raise 'must_send_envelope_id_inside_body'
-      end
-
-      request :patch,
-        api_url(model_name, key),
-        build_data(params, model_name, key ),
-        {}
+    def model_name
+      self.class.model_name
     end
 
-    def self.remove key
-      request :delete,
-        api_url(model_name, key),
+    def activate params={ status: 'running' }
+      Base.request :patch,
+        Base.api_url(model_name, @envelope_key),
+        Base.build_data(params, model_name, @envelope_key),
         {}
     end
   end

data/lib/clicksign/requirement.rb

@@ -0,0 +1,24 @@
+module Clicksign
+  class Requirement < Base
+    def self.model_name
+      'requirements'
+    end
+
+    attr_accessor :envelope_key
+
+    def initialize(envelope_key)
+      @envelope_key = envelope_key
+    end
+
+    def model_name
+      self.class.model_name
+    end
+
+    def add params={}, custom_params={}
+      Base.request :post,
+        Base.api_url('envelopes', @envelope_key, model_name),
+        Base.build_data(params, model_name, '', custom_params),
+        {}
+    end
+  end
+end

data/lib/clicksign/signer.rb

@@ -10,10 +10,14 @@ module Clicksign
       @envelope_key = envelope_key
     end
 
+    def model_name
+      self.class.model_name
+    end
+
     def add params={}
       Base.request :post,
-        Base.api_url('envelopes', @envelope_key, Signer.model_name),
-        Base.build_data(params, Signer.model_name),
+        Base.api_url('envelopes', @envelope_key, model_name),
+        Base.build_data(params, model_name),
         {}
     end
   end

data/lib/clicksign/version.rb

@@ -1,3 +1,3 @@
 module Clicksign
-  VERSION = '1.0'
+  VERSION = '1.2'
 end

data/lib/clicksign.rb

@@ -6,6 +6,7 @@ require 'clicksign/base'
 require 'clicksign/envelope'
 require 'clicksign/document'
 require 'clicksign/signer'
+require 'clicksign/requirement'
 
 module Clicksign
   class << self
@@ -14,7 +15,6 @@ module Clicksign
 
   def self.configure(&block)
     self.api_version = 'v3'
-    self.environment = :sandbox
 
     if self.environment.to_sym == :production
       self.host = "https://app.clicksign.com"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign_ruby
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.2'
 platform: ruby
 authors:
 - davi-canuto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -85,11 +85,12 @@ files:
 - lib/clicksign/base.rb
 - lib/clicksign/document.rb
 - lib/clicksign/envelope.rb
+- lib/clicksign/requirement.rb
 - lib/clicksign/signer.rb
 - lib/clicksign/version.rb
 - spec/clicksign_spec.rb
 - spec/spec_helper.rb
-homepage: 
+homepage: https://github.com/davi-canuto/clicksign-ruby
 licenses:
 - MIT
 metadata: {}
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: Ruby library to interact with Clicksign