setka-workflow 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0098fac4579ad93428e7e9381e6a4c08143a023
-  data.tar.gz: a88666ec495738c7dae0f8b6613e5184b1997c3d
+  metadata.gz: 984c7eb517da01a15112df082649571809af9ba1
+  data.tar.gz: 9d37f010305da4fde4af901230b28c82b1eba04e
 SHA512:
-  metadata.gz: 7003d0b32b22269d743023462f4068da3d73004f9e1207e5d07d5e6f38e1b3226173d015c6c1451e5ca8f5147d514789e4bad5629541e5918405f85f10e347ca
-  data.tar.gz: 6ae7842f6ef285f22dbc44d8ed307f6a941812d3e1df92433e6a1d6023c87bf7ce62e9998ed0dc037161d68743b0ebfeca20d1e515c37a463d57ac303802957e
+  metadata.gz: cbc377ec10c5a5babdf3c2d320875059f9254ce31761b7767a2dbf56884c4594674a07b60e10ba7e9c6938be622b42e3dffa3001d8c2b76327153230230745bb
+  data.tar.gz: ed243ad7a18de82380cfb0b53e6740f3c94a3ce034f905d21f790e5993d16555ca98d0cd6e0b31e4168536c0ce98c99fef523111e4369dc930bb23e4078455b7

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# v0.1.1 2017-09-01
+
+## Changed
+
+* Added rubydoc comments for main methods and points
+
+# v0.1.0 2017-09-01
+
+First public release

data/lib/setka/workflow.rb

@@ -1,5 +1,13 @@
 require 'setka/workflow/version'
 
+# Ruby implementations of Setka Workflow API for integration an external
+# publishing platform written in the Ruby language with Setka Workflow.
+#
+# First of all access token should be obtained. It can be acomplished on
+# Integration page of Settings
+# (https://workflow.setka.io/spacename/settings/api
+# where spacename is name of your space).
+
 module Setka
   module Workflow
     autoload :Client,            'setka/workflow/client'
@@ -11,22 +19,36 @@ module Setka
     autoload :Category,          'setka/workflow/category'
 
     BASE_ENDPOINT = 'workflow.setka.io'.freeze
+
+    # Current default version of API
     API_VERSION = 3
 
+    # Basic Workflow error
     Error = Class.new(StandardError)
+
+    # This error is thrown when your client has not been configured
     ConfigurationError = Class.new(Error)
+
+    # This error is thrown when format of the param is wrong
     WrongParamError = Class.new(Error)
+
+    # This error is thrown when access token is invalid
     InvalidAccessToken = Class.new(Error)
+
+    # This error is thrown when Setka Workflow responds with 500
     InternalServerError = Class.new(Error)
 
+    # Clears current client
     def self.reset!
       @client = nil
     end
 
+    # Gets current client
     def self.client
       @client ||= Setka::Workflow::Client.new
     end
 
+    # Workflow client configuration in the global manner
     def self.configure(&block)
       reset!
       client.configure(&block)
@@ -36,6 +58,7 @@ module Setka
       @logger ||= Logger.new(STDOUT)
     end
 
+    # Sets custom logger
     def self.logger=(logger)
       @logger = logger
     end

data/lib/setka/workflow/category.rb

@@ -1,15 +1,49 @@
 module Setka
   module Workflow
     class Category < Resource
+      # Methods set to work with çategories
       class << self
+        # Creates a category.
+        #
+        # @param [Hash] body Attributes of a new category.
+        #
+        # @param [Hash] options Additional options (explicit HTTP headers,
+        #     specific Client object).
+        #
+        # @raise  [Workflow::Category] If something went wrong during category's
+        #     creation.
+        #
+        # @return [Hash] Hash of category's attibutes.
         def create(body, options = {})
           collection(:post, nil, body, options)
         end
 
+        # Updates a category.
+        # @param [Integer] id Category's id
+        #
+        # @param [Hash] body Category's attributes to update.
+        #
+        # @param [Hash] options Additional options (explicit HTTP headers,
+        #     specific Client object).
+        #
+        # @raise  [Workflow::Category] If something went wrong during category's
+        #     updating.
+        #
+        # @return [Hash] Hash of category's attibutes.
         def update(id, body, options = {})
           member(:patch, id, nil, body, options)
         end
 
+        # Deletes a category.
+        # @param [Integer] id Category's id
+        #
+        # @param [Hash] options Additional options (explicit HTTP headers,
+        #     specific Client object).
+        #
+        # @raise  [Workflow::Category] If something went wrong during category's
+        #     deleting.
+        #
+        # @return [Hash] Hash of category's attibutes.
         def delete(id, options = {})
           member(:delete, id, nil, nil, options)
         end

data/lib/setka/workflow/resource.rb

@@ -2,10 +2,14 @@ module Setka
   module Workflow
     class Resource
       class << self
+        # Abstract operation's execution over a member of a resource.
+        #
         def member(http_verb, id, action = nil, body = nil, options)
           actual_client(options).send(http_verb, path(action, id), body, options)
         end
 
+        # Abstract operation's execution over a collection of a resource.
+        #
         def collection(http_verb, action = nil, body = nil, options)
           actual_client(options).send(http_verb, path(action), body, options)
         end

data/lib/setka/workflow/ticket.rb

@@ -1,19 +1,64 @@
 module Setka
   module Workflow
     class Ticket < Resource
+      # Methods set to work with tickets
       class << self
+        # Publishes a ticket.
+        #
+        # @param [Integer] id Ticket's id.
+        #
+        # @param [Hash] options Additional options (explicit HTTP headers,
+        #     specific Client object).
+        #
+        # @raise  [Workflow::Ticket] if a ticket with the given ID could not be found,
+        #     if the ticket is already published.
+        #
+        # @return [Hash] Hash of ticket's attibutes.
         def publish(id, options = {})
           member(:patch, id, :publish, nil, options)
         end
 
+        # Unpublishes a ticket.
+        #
+        # @param [Integer] id Ticket's id.
+        #
+        # @param [Hash] options Additional options (explicit HTTP headers,
+        #     specific Client object).
+        #
+        # @raise  [Workflow::Ticket] if a ticket with the given ID could not be found,
+        #     if the ticket is already unpublished.
+        #
+        # @return [Hash] Hash of ticket's attibutes.
         def unpublish(id, options = {})
           member(:patch, id, :unpublish, nil, options)
         end
 
+        # Updates a ticket.
+        #
+        # @param [Integer] id Ticket's id.
+        #
+        # @param [Hash] body Hash with ticket's attributes to update.
+        #
+        # @param [Hash] options Additional options (explicit HTTP headers,
+        #     specific Client object).
+        #
+        # @raise  [Workflow::Ticket] if a ticket with the given ID could not be found,
+        #     if format of some attribute(s) is wrong (e.g. date and published_at
+        #     should be passed as unix timestamps).
+        # @return [Hash] Hash of ticket's attibutes.
         def update(id, body, options = {})
           member(:patch, id, nil, body, options)
         end
 
+        # Sync ticket's analytics.
+        #
+        # @param [Hash] body Hash with ticket's attributes to update.
+        #
+        # @param [Hash] options Additional options (explicit HTTP headers,
+        #     specific Client object).
+        #
+        # @return [Array] Array of hashes with ticket's views and comment counts
+        #      and the result of syncing.
         def sync_analytics(body, options = {})
           collection(:patch, :sync_analytics, body, options)
         end

data/lib/setka/workflow/version.rb

@@ -1,5 +1,5 @@
 module Setka
   module Workflow
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: setka-workflow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dmitry Kovalevsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2017-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -90,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt