signnow-ruby 0.0.2

data/lib/signnow/base.rb

@@ -0,0 +1,45 @@
+module Signnow
+  class Base
+    include Signnow::Operations::All
+    include Signnow::Operations::Create
+    include Signnow::Operations::Find
+
+    attr_accessor :created
+
+    # Initializes the object using the given attributes
+    #
+    # @param [Hash] attributes The attributes to use for initialization
+    def initialize(attributes = {})
+      set_attributes(attributes)
+      parse_timestamps
+    end
+
+    # Model validations
+    #
+    # @return [Boolean]
+    def valid?
+      self.errors.empty?
+    end
+
+    # Accesor for the errors
+    #
+    def errors
+      @errors || []
+    end
+
+    # Sets the attributes
+    #
+    # @param [Hash] attributes The attributes to initialize
+    def set_attributes(attributes)
+      attributes.each_pair do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    # Parses UNIX timestamps and creates Time objects.
+    def parse_timestamps
+      @created = created.to_i if created.is_a? String
+      @created = Time.at(created) if created
+    end
+  end
+end

data/lib/signnow/client.rb

@@ -0,0 +1,29 @@
+module Signnow
+  class Client
+    attr_reader :access_token
+
+    # Creates an account object using the given Signnow user.
+    # existing account.
+    #
+    # @param [String] User access token to use the signnow api.
+    def initialize(access_token=nil)
+      @access_token = access_token
+      self
+    end
+
+    # Executes block with the access token
+    #
+    # @param [block] block to execute
+    #
+    # @example [description]
+    # client = Signnow::Client.new('_user_auth_')
+    # client.perform! do |access_token|
+    #   Signnow::User.show(access_token: access_token)
+    # end
+    def perform!(&block)
+      raise Signnow::AuthenticationError unless access_token
+      block.call(access_token)
+    end
+
+  end
+end

data/lib/signnow/document.rb

@@ -0,0 +1,28 @@
+module Signnow
+  class Document < Base
+    include Signnow::Operations::Show
+    include Signnow::Operations::All
+    include Signnow::Operations::DownloadLink
+
+    attr_accessor :id, :user_id, :document_name, :page_count, :created,
+    :updated, :original_filename, :thumbnail, :signatures, :seals, :texts,
+    :inserts, :tags, :fields, :requests, :notary_invites, :version_time, :pages
+
+    # Parses UNIX timestamps and creates Time objects.
+    def parse_timestamps
+      super
+      @updated = updated.to_i if updated.is_a? String
+      @updated = Time.at(updated) if updated
+    end
+
+    class << self
+      # Redefining the documents api endpoint
+      #
+      def api_all_url
+          "user/documentsv2"
+      end
+      protected :api_all_url
+    end
+
+  end
+end

data/lib/signnow/operations/all.rb

@@ -0,0 +1,51 @@
+module Signnow
+  module Operations
+    module All
+      module ClassMethods
+        # Retrieves all available objects from the Signnow API
+        #
+        # @param [Hash] options Options to pass to the API
+        # @return [Array] The available objects
+        def all(attributes = {})
+          response = Signnow.request(:get, nil, api_all_url , attributes, options_for_all(attributes))
+          results_from response
+        end
+
+        # URl for the all endpoint
+        # overwrite this in the model if the api is not well named
+        #
+        def api_all_url
+          "#{self.name.split("::").last.downcase}"
+        end
+        protected :api_all_url
+
+        # Options for all
+        # overwrite this in the model to set security
+        #
+        # @return [Hash]
+        def options_for_all(attributes)
+          access_token = attributes.delete(:access_token)
+          raise AuthenticationError unless access_token
+          {
+            auth_type: :user_token,
+            auth_token: access_token
+          }
+        end
+
+        private
+        def results_from(response)
+          results = []
+          response.each do |obj|
+            results << self.new(obj)
+          end
+          results
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/signnow/operations/create.rb

@@ -0,0 +1,35 @@
+module Signnow
+  module Operations
+    module Create
+      module ClassMethods
+        # Creates a new object
+        #
+        # @param [Hash] attributes The attributes of the created object
+        def create(attributes)
+          response = Signnow.request(:post, nil, api_create_url, attributes, options_for_create)
+          self.new(response)
+        end
+
+        # URl for the create endpoint
+        # overwrite this in the model if the api is not well named
+        #
+        def api_create_url
+          "#{self.name.split("::").last.downcase}"
+        end
+        protected :api_create_url
+
+        # Options for create
+        # overwrite this in the model if the api is not well named
+        #
+        # @return [Hash]
+        def options_for_create
+          { auth_type: :basic }
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/signnow/operations/delete.rb

@@ -0,0 +1,42 @@
+module Signnow
+  module Operations
+    module Delete
+      module ClassMethods
+        # Deletes the given object
+        #
+        # @param [Integer] id The id of the object that gets deleted
+        def delete(attributes={})
+          id = attributes.delete(:id)
+          response = Signnow.request(:delete, nil, api_delete_url(id) , {}, options_for_delete(attributes))
+          true
+        end
+
+        # URl for the delete endpoint
+        # overwrite this in the model if the api is not well named
+        #
+        def api_delete_url(id)
+          "#{self.name.split("::").last.downcase}s/#{id}"
+        end
+        protected :api_delete_url
+
+        # Options for delete
+        # overwrite this in the model to set security
+        #
+        # @return [Hash]
+        def options_for_delete(attributes)
+          access_token = attributes.delete(:access_token)
+          raise AuthenticationError unless access_token
+          {
+            auth_type: :user_token,
+            auth_token: access_token
+          }
+        end
+        protected :options_for_delete
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/signnow/operations/download_link.rb

@@ -0,0 +1,41 @@
+module Signnow
+  module Operations
+    module DownloadLink
+      module ClassMethods
+        # Request a one time download
+        #
+        def download_link(attributes={})
+          response = Signnow.request(:post, nil, api_download_link_url(attributes[:id]), {}, options_for_download_link(attributes))
+          response['link']
+        end
+
+        # URl for the show endpoint
+        # overwrite this in the model if the api is not well named
+        #
+        def api_download_link_url(id=nil)
+          url = "#{self.name.split("::").last.downcase}"
+          url += "/#{id}" if id
+          url += "/download/link"
+          url
+        end
+        protected :api_download_link_url
+
+        # Options for show
+        # overwrite this in the model to set security
+        #
+        # @return [Hash]
+        def options_for_download_link(attributes)
+          raise AuthenticationError unless attributes[:access_token]
+          {
+            auth_type: :user_token,
+            auth_token: attributes[:access_token]
+          }
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/signnow/operations/find.rb

@@ -0,0 +1,43 @@
+module Signnow
+  module Operations
+    module Find
+      module ClassMethods
+        # Finds a given object
+        #
+        # @param [Integer] id The id of the object that should be found
+        # @return [Signnow::Base] The found object
+        def find(attibutes)
+          id = attibutes.delete(:id)
+          response = Signnow.request(:get, nil, api_find_url(id), {}, options_for_find(attributes))
+          self.new(response["data"])
+        end
+
+        # URl for the find endpoint
+        # overwrite this in the model if the api is not well named
+        #
+        def api_find_url(id)
+          "#{self.name.split("::").last.downcase}s/#{id}"
+        end
+        protected :api_find_url
+
+        # Options for find
+        # overwrite this in the model to set security
+        #
+        # @return [Hash]
+        def options_for_find(attributes)
+          access_token = attributes.delete(:access_token)
+          raise AuthenticationError unless access_token
+          {
+            auth_type: :user_token,
+            auth_token: access_token
+          }
+        end
+        protected :options_for_find
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/signnow/operations/show.rb

@@ -0,0 +1,42 @@
+module Signnow
+  module Operations
+    module Show
+      module ClassMethods
+        # Shows a given object
+        #
+        # @param [Integer] id The id of the object that should be shown
+        # @return [Signnow::Base] The found object
+        def show(attributes={})
+          response = Signnow.request(:get, nil, api_show_url(attributes[:id]), {}, options_for_show(attributes))
+          self.new(response)
+        end
+
+        # URl for the show endpoint
+        # overwrite this in the model if the api is not well named
+        #
+        def api_show_url(id=nil)
+          url = "#{self.name.split("::").last.downcase}"
+          url += "/#{id}" if id
+          url
+        end
+        protected :api_show_url
+
+        # Options for show
+        # overwrite this in the model to set security
+        #
+        # @return [Hash]
+        def options_for_show(attributes)
+          raise AuthenticationError unless attributes[:access_token]
+          {
+            auth_type: :user_token,
+            auth_token: attributes[:access_token]
+          }
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/signnow/operations/update.rb

@@ -0,0 +1,52 @@
+module Signnow
+  module Operations
+    module Update
+
+      module ClassMethods
+        # Updates a object
+        # @param [Integer] id The id of the object that should be updated
+        # @param [Hash] attributes The attributes that should be updated
+        def update_attributes(attributes={})
+          id = attributes.delete(:id)
+          response = Signnow.request(:put, nil, api_update_url(id), attributes, options_for_update(attributes))
+          self.new(response["data"])
+        end
+
+        # URl for the update endpoint
+        # overwrite this in the model if the api is not well named
+        #
+        def api_update_url(id=nil)
+          url = "#{self.name.split("::").last.downcase}"
+          url += "/#{id}" if id
+          url
+        end
+        protected :api_update_url
+
+        # Options for update
+        # overwrite this in the model to set security
+        #
+        # @return [Hash]
+        def options_for_update(attributes)
+          access_token = attributes.delete(:access_token)
+          raise AuthenticationError unless access_token
+          {
+            auth_type: :user_token,
+            auth_token: access_token
+          }
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Updates a object
+      #
+      # @param [Hash] attributes The attributes that should be updated
+      def update_attributes(attributes)
+        response = Signnow.request(:put, nil, "#{self.class.name.split("::").last.downcase}/#{id}", attributes)
+        set_attributes(response["data"])
+      end
+    end
+  end
+end

data/lib/signnow/request/base.rb

@@ -0,0 +1,34 @@
+module Signnow
+  module Request
+    class Base
+      attr_reader :info
+      attr_accessor :response
+
+      def initialize(info)
+        @info = info
+      end
+
+      def perform
+        raise AuthenticationError if Signnow.encoded_app_credentials.nil?
+        connection.setup_https
+        send_request
+
+        validator.validated_data_for(response)
+      end
+
+      protected
+
+      def send_request
+        self.response = connection.request
+      end
+
+      def connection
+        @connection ||= Connection.new(info)
+      end
+
+      def validator
+        @validator ||= Validator.new(info)
+      end
+    end
+  end
+end