batchly-sdk 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9478b8678d7cbf01eadc1a13efb0a8cdd16c1011
+  data.tar.gz: aa728e723f1c612650a73dade9396cfe12aba993
+SHA512:
+  metadata.gz: bc805adb475825c730deb7a287359b98f0e933ade9b13a8b04a7410a216bced7005e5c511a95799531a026b081b2058ea528a29bafd72c316f51cd2aeec85f18
+  data.tar.gz: 349f2155b6e0621572ef3573aced79ca66441425d08f8d1419752e9b2442df6d744cc65deed7951f075504718cc15722a78571926d75e1375102aa36147a1237

data/lib/batchly-sdk.rb

@@ -0,0 +1,30 @@
+require_relative 'batchly-sdk/iprocessor'
+
+require_relative 'batchly-sdk/request/irequest'
+require_relative 'batchly-sdk/request/db_request'
+require_relative 'batchly-sdk/request/file_request'
+require_relative 'batchly-sdk/request/queue_request'
+require_relative 'batchly-sdk/request/delimited_request'
+
+require_relative 'batchly-sdk/response/iresponse'
+require_relative 'batchly-sdk/response/default_response'
+require_relative 'batchly-sdk/response/file_response'
+require_relative 'batchly-sdk/response/db_response'
+
+##
+# Batchly SDK is a service provider interface offered to create processors for use in batchly
+# http://www.batchly.net
+module Batchly
+
+  ##
+  # All request types that batchly supports for different data sources are available as part of this module
+  # Currently supports QueueRequest, FileRequest, DelimitedRequest and DbRequest
+  module Request
+  end
+
+  ##
+  # All response types that batchly supports for different data destinations are available as part of this module
+  # Currently supports DefaultResponse, FileResponse and DbResponse
+  module Response
+  end
+end

data/lib/batchly-sdk/iprocessor.rb

@@ -0,0 +1,36 @@
+require_relative "request/irequest"
+
+module Batchly
+
+  ##
+  # This is the basic interface for implementation of a processor.  The name of the class is IProcessor to keep it compliant with other language sdk.
+  # Ruby doesn't support interfaces and so this base abstract class needs to be extended to write a new processor
+  class IProcessor
+    ##
+    # Process method should be implemented in a stateless manner to ensure fault tolerance.
+    # Once implemented, all the files along with necessary dependencies should be compressed into a zip folder and uploaded into batchly portal to create a new processor.
+    # While uploading the processor, you need to configure the right request/response parameters for ensuring the right bootstrapping during operations.
+    # You can consider the parameters as Idempotent as long as you configure the same on portal.  The parameters will be assigned automatically during Job run.
+    #
+    #
+    # Supports the following implementations.
+    #
+    # 1. QueueRequest - The unique identifier for UoW will be assigned and sent to processor. Actual usage is completely within the processor Implementation.
+    # 2. FileRequest - Built for file storage input sources.  The file would be downloaded from storage and saved to local disk.
+    # 3. DelimitedFileRequest - Built for file storage input sources.
+    # 4. DbRequest - Records would be retrieved from the give database/table connectionString
+    # </param>
+    # <returns>
+    #
+    # Supports the following implementations.
+    #
+    # 1. DefaultResponse - Share the status of your processing.
+    # 2. FileResponse - Built for file storage output.  Allows processor to share the location of response files that need to be saved to storage.
+    # 3. DbResponse - updates the database for the process input TableDataRequest record.
+    #
+    # </returns>
+    def process(request)
+      raise 'this method should be overriden and return the IResponse object'
+    end
+  end
+end

data/lib/batchly-sdk/request/db_request.rb

@@ -0,0 +1,36 @@
+require_relative 'irequest'
+
+module Batchly
+  module Request
+
+    ##
+    # DbRequest is a type of request that supports relational data sources
+    # Request holds the base data and source connection string
+    class DbRequest < IRequest
+
+      def initialize(id = nil, parameters = nil, connection_string = nil, data = nil, content_path = nil)
+        @id = id
+        @parameters = parameters
+        @connection_string = connection_string
+        @data = data
+        @content_path = content_path
+      end
+
+      # id for the Unit of Work +string+
+      attr_accessor :id
+
+      # Values for parameters configured via UI +hashTable+
+      attr_accessor :parameters
+
+      # connection string +string+
+      attr_accessor :connection_string
+
+      # dataset of data required to process unit of work. +hashTable+
+      # If the configured query returns multiple record sets, each record set is a table within the dataset.
+      attr_accessor :data
+
+      # Path for loading additional content - Path to container from where code is executed +string+
+      attr_accessor :content_path
+    end
+  end
+end

data/lib/batchly-sdk/request/delimited_request.rb

@@ -0,0 +1,34 @@
+require_relative 'irequest'
+
+module Batchly
+  module Request
+
+    ##
+    # DelimitedFileRequest is a type of request that supports csv and other delmited type of source files
+    # Request holds the fields as an array.  The fields are column values from a single row
+    class DelimitedFileRequest < IRequest
+
+      def initialize(id = nil, parameters = nil, fields = nil, content_path = nil)
+        @id = id
+        @parameters = parameters
+        @fields = fields
+        @content_path = content_path
+      end
+
+      # Unique id of the Unit of Work +string+
+      attr_accessor :id
+
+      # parameters that has been configured in portal +hashTable+
+      attr_accessor :parameters
+
+      # Fields contain the individual columns of a delimited row +array+
+      attr_accessor :fields
+
+
+      # Path for loading additional content - Path to container from where code is executed +string+
+      attr_accessor :content_path
+
+    end
+
+  end
+end

data/lib/batchly-sdk/request/file_request.rb

@@ -0,0 +1,30 @@
+  require_relative 'irequest'
+
+  module Batchly
+    module Request
+      ##
+      # FileRequest is a type of request that supports file storage
+      # Request holds the location of the file thats available for your processing
+      class FileRequest < IRequest
+
+        def initialize(id = nil, parameters = nil, location = nil, content_path = nil )
+          @id = id
+          @parameters = parameters
+          @location = location
+          @content_path = content_path
+        end
+
+        # Unique id of the Unit of Work +string+
+        attr_accessor :id
+
+        # parameters that has been configured in portal +hashTable+
+        attr_accessor :parameters
+
+        # Location of the file on disk +string+
+        attr_accessor :location
+
+        # Path for loading additional content - Path to container from where code is executed +string+
+        attr_accessor :content_path
+      end
+    end
+  end

data/lib/batchly-sdk/request/irequest.rb

@@ -0,0 +1,21 @@
+
+module Batchly
+  module Request
+
+    ##
+    # IRequest is the base interface for all request types
+    # Use the actual implementations while duck typing - File, Delimited, Db or Queue
+    class IRequest
+
+      # id for the Unit of Work +string+
+      attr_accessor :id
+
+      # Values for parameters configured via UI +hashTable+
+      attr_accessor :parameters
+
+      # Current working directory +string+
+      attr_accessor :content_path
+
+    end
+  end
+end

data/lib/batchly-sdk/request/queue_request.rb

@@ -0,0 +1,33 @@
+  require_relative 'irequest'
+  require 'json'
+
+  module Batchly
+    module Request
+
+      ##
+      # QueueRequest is a type of request that supports pub/sub or queue sources
+      # Request holds the content of a single message
+      class QueueRequest < IRequest
+
+        def initialize(id = nil, parameters = nil, content = nil, content_path = nil )
+          @id = id
+          @parameters = parameters
+          @content = content
+          @content_path = content_path
+        end
+
+        # id for the Unit of Work +string+
+        attr_accessor :id
+
+        # Values for parameters configured via UI +hashTable+
+        attr_accessor :parameters
+
+        # Path for content +string+
+        attr_accessor :content
+
+        # Path for loading additional content - Path to container from where code is executed +string+
+        attr_accessor :content_path
+
+      end
+    end
+  end

data/lib/batchly-sdk/response/db_response.rb

@@ -0,0 +1,25 @@
+require_relative 'iresponse'
+
+module Batchly
+  module Response
+
+    ##
+    # The DbResponse is a type of response when you want batchly to execute queries on destination database
+    class DbResponse < IResponse
+
+      # Unique id of the Unit of Work +string+
+      attr_accessor :id
+
+      # Status of the processing +boolean+
+      attr_accessor :is_processing_success
+
+      # Parameter Name and Data pair for each parameter of the SQL Query that is run on successful processing +hashTable+
+      # The query is configured as part of Batchly Portal and is run in sequence to ensure successful writes to the database.
+      attr_accessor  :parameter_values
+
+      # Duplicate message that can be deleted without any post processing +boolean+
+      attr_accessor :is_duplicate
+
+    end
+  end
+end

data/lib/batchly-sdk/response/default_response.rb

@@ -0,0 +1,24 @@
+require_relative 'iresponse'
+
+module Batchly
+  module Response
+
+    ##
+    # This is the minimal response to return when the processing doesn't generate any output that requires processing by batchly agent
+    # The *is_processing_success* represents status of processing. +boolean+  _true_ for success and _false_ for failure
+    # The *is_duplicate* field represents duplicate tracking if state is managed by processor.
+    # The *id* should equal the request id
+    class DefaultResponse < IResponse
+
+      # Unique id of the Unit of Work +string+
+      attr_accessor :id
+
+      # Status of the processing +boolean+
+      attr_accessor :is_processing_success
+
+      # Duplicate message that can be deleted without any post processing +boolean+
+      attr_accessor :is_duplicate
+    end
+
+  end
+end

data/lib/batchly-sdk/response/file_response.rb

@@ -0,0 +1,29 @@
+require_relative 'iresponse'
+
+module Batchly
+  module Response
+
+    ##
+    # FileResponse is the type of response to return when you generate a file output
+    # Batchly Agent automatically takes the output file and sends it to the right destination(s)
+    # The destinations are configured from the portal and is processor independent
+    # Destinations are attached at the Job Level. The processor is reusable across many jobs without knowing the source and destination
+    class FileResponse < IResponse
+
+      # Unique id of the Unit of Work +string+
+      attr_accessor :id
+
+      # Status of the processing +boolean+
+      attr_accessor :is_processing_success
+
+      # locations of the ouptut files on disk +Array+
+      # One full path per output file.  Disk File Name is used as file name for response.
+      # E.g.:- C:\Processed\Output\File1.png - Saved to storage as File.Png
+      attr_accessor :locations
+
+      # Duplicate message that can be deleted without any post processing +boolean+
+      attr_accessor :is_duplicate
+
+    end
+  end
+end

data/lib/batchly-sdk/response/iresponse.rb

@@ -0,0 +1,24 @@
+module Batchly
+  module Response
+
+    ##
+    # This is the basic interface for returning the values post processing
+    # Use the implemented classes for returning the right type of bootstrapping by the batchly agent
+    # Supported implementations are:-
+    # * DefaultResponse
+    # * FileResponse
+    # * DbResponse
+    class IResponse
+
+     # Unique id of the Unit of Work
+      attr_accessor :id
+
+      # Status of the processing
+      attr_accessor :is_processing_success
+
+      # Duplicate message that can be deleted without any post processing
+      attr_accessor :is_duplicate
+
+      end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: batchly-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Batchly Tech Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies: []
+description: A simple interface for writing new processors for using batchly
+email: support@batchly.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/batchly-sdk.rb
+- lib/batchly-sdk/iprocessor.rb
+- lib/batchly-sdk/request/db_request.rb
+- lib/batchly-sdk/request/delimited_request.rb
+- lib/batchly-sdk/request/file_request.rb
+- lib/batchly-sdk/request/irequest.rb
+- lib/batchly-sdk/request/queue_request.rb
+- lib/batchly-sdk/response/db_response.rb
+- lib/batchly-sdk/response/default_response.rb
+- lib/batchly-sdk/response/file_response.rb
+- lib/batchly-sdk/response/iresponse.rb
+homepage: http://www.batchly.net
+licenses:
+- Proprietary
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0.pre.p647
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Batchly Processor SDK
+test_files: []