circuit_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 07c5becef6eac99b973f2e39351fc53e4d9633a9
-  data.tar.gz: 4208a620334d4645e5e54ba0ff1d3614fa518387
+SHA256:
+  metadata.gz: 44b59486d0af395164c4ba24986dbc36fb553aaf00b1d2621766d8227e820000
+  data.tar.gz: 4fb9e02e4f19d42be8e62c0e1efed8c3eff8f49c3a7f904a8444a53131c02d82
 SHA512:
-  metadata.gz: 68b9c6b6d0a09117bdc9937528cbb2d234f0d9ec587b8ff17a0e5342c7f7a8d3d9590508407e803cd997af9453a19baedc7727aa136a8c5629e3f529463a2a9a
-  data.tar.gz: 7a0d273864893ddb6fb698f8ff18bc069bb386b41cfe35ba682af0b5cc8bd720663f65983cdd7dbacaeea119e8042b26363d25b2067e8321666e6998b27936d0
+  metadata.gz: '08180e655db091020cb66e6c4a8e2f0eb609c4ae14188615a912faaf4734223803bb1c6ec1bc236cb335c1c26fe6cb31da16c995f83c9e353862ad0548f0a953'
+  data.tar.gz: d37e67f5acbe6096cb0c8434cdd6fe22beb947a3de2338f4d66c3f7794d2df9dfecee6b389c159363c8dc568bc4ad7858d24322495e3243367947c60f61cc0e3

data/lib/circuit_client/client.rb

@@ -7,33 +7,34 @@ require 'json'
 require 'circuit_client/error_middleware'
 
 module CircuitClient
+  # client for accessing circuit API
   class Client
     # Set the hostname of the circuit system
     attr_accessor :host
 
-		# The base path of the API
+    # The base path of the API
     attr_accessor :base_path
 
-		# The protocol to use 'http' or 'https'
+    # The protocol to use 'http' or 'https'
     attr_accessor :protocol
 
-		# Timeout for http requests
+    # Timeout for http requests
     attr_accessor :timeout
 
-		# The client_id for authentication
+    # The client_id for authentication
     attr_accessor :client_id
 
-		# The client_secret for authentication
+    # The client_secret for authentication
     attr_accessor :client_secret
 
-		# The authentication method to use (currently only :client_credentials supported)
+    # The authentication method to use (currently only :client_credentials supported)
     attr_accessor :auth_method
 
-		# Enable tracing (outputs http requests to STDOUT)
-		attr_accessor :trace
+    # Enable tracing (outputs http requests to STDOUT)
+    attr_accessor :trace
 
-		# Initialize a new client
-		# 
+    # Initialize a new client
+    # 
     # Examples
     #
     #   CircuitClient::Client.new do |c|
@@ -52,7 +53,7 @@ module CircuitClient
       yield self
     end
 
-		# The faraday http connection object
+    # The faraday http connection object
     def connection
       @connection ||= Faraday.new(url: base_uri.to_s) do |faraday|
         faraday.response :logger if @trace
@@ -61,7 +62,7 @@ module CircuitClient
       end
     end
 
-		# The token used for authentication
+    # The token used for authentication
     def access_token
       return @access_token unless @access_token.nil?
       case @auth_method
@@ -72,7 +73,7 @@ module CircuitClient
       end
     end
 
-		# Authenticate using client_credentials method
+    # Authenticate using client_credentials method
     def auth_client_credentials
       raise "client_id parameter required" if @client_id.nil?
       raise "client_secret parameter required" if @client_secret.nil?
@@ -86,31 +87,47 @@ module CircuitClient
       data['access_token']
     end
 
-		# Return URI with path elements
+    # Return URI with path elements
     def base_uri
       URI("#{@protocol}://#{@host}")
     end
 
-		# Returns an URI with the base_uri and the supplied path
+    # Returns an URI with the base_uri and the supplied path
     def build_uri(path)
       uri = base_uri
       uri.path = path
       uri.to_s
     end
 
-		# Returns an URI and with a path relative to the base_path of the API
+    # Returns an URI and with a path relative to the base_path of the API
     def build_api_uri(path)
       build_uri("#{@base_path}#{path}")
     end
 
-		# Create a new message in a existing conversation
-		#
-		# Examples
+    # Create a new message in a existing conversation
     #
-    #   client.create_message('<convId>', 'my message text...', subject: 'Todays meeting')
+    # Examples
+    #
+    #   client.create_message(
+    #     '<convId>',
+    #     'my message text...',
+    #     subject: 'Todays meeting'
+    #   )
+    #
+    # To send to an existing message item use :item_id parameter:
+    #
+    #   client.create_message(
+    #     '<convId>',
+    #     'my message text...',
+    #     item_id: 'itemId'
+    #   )
     #
     def create_message(conv, text, **options)
-      call(:post, "/conversations/#{conv}/messages", {
+      item_id = options[:item_id]
+      path = "/conversations/#{conv}/messages"
+      path += "/#{item_id}" unless item_id.nil?
+      options.delete(:item_id)
+      call(:post, path, {
         'content' => text,
         **options,
       } )
@@ -121,7 +138,7 @@ module CircuitClient
       call(:get, "/conversations")
     end
 
-		# Create a new group conversation
+    # Create a new group conversation
     def create_group_conversation(participants, topic)
       call(:post, '/conversations/group', {
         participants: participants,
@@ -129,14 +146,14 @@ module CircuitClient
       } )
     end
 
-		# Create a new 1:1 conversation
+    # Create a new 1:1 conversation
     def create_direct_conversation(participant)
       call(:post, '/conversations/direct', {
         participant: participant,
       } )
     end
 
-		# Remove participants from a conversation
+    # Remove participants from a conversation
     def delete_group_conversation_participants(conv, participants)
       call(:delete, "/conversations/group/#{conv}/participants", {
         participants: participants,
@@ -148,7 +165,7 @@ module CircuitClient
       delete_group_conversation_participants(conv, [current_user['userId']])
     end
 
-		# Get the profile of the connections user
+    # Get the profile of the connections user
     def get_user_profile
       call(:get, "/users/profile")
     end
@@ -158,17 +175,17 @@ module CircuitClient
       @current_user ||= get_user_profile
     end
 
-		# Get profile of a user
+    # Get profile of a user
     def get_users(id)
       call(:get, "/users/#{id}")
     end
 
-		# Get presence information of a user
+    # Get presence information of a user
     def get_users_presence(id)
       call(:get, "/users/#{id}/presence")
     end
 
-		private
+    private
 
     def call(method, path, payload = {}, headers = {})
       response = connection.send(method) do |req|
@@ -186,7 +203,5 @@ module CircuitClient
       end
       return JSON.parse(response.body) if response.success?
     end
-
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Markus Benning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple client for circuit REST API