circuit_client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b59486d0af395164c4ba24986dbc36fb553aaf00b1d2621766d8227e820000
-  data.tar.gz: 4fb9e02e4f19d42be8e62c0e1efed8c3eff8f49c3a7f904a8444a53131c02d82
+  metadata.gz: e8ede2c67d6007b81a374d34013c55ecb6031aca0aabd1cbd15685882dbc10a7
+  data.tar.gz: c750950b29ed485c4c662ac2593b07ac005271b42103d640c2cb71a0fd72900f
 SHA512:
-  metadata.gz: '08180e655db091020cb66e6c4a8e2f0eb609c4ae14188615a912faaf4734223803bb1c6ec1bc236cb335c1c26fe6cb31da16c995f83c9e353862ad0548f0a953'
-  data.tar.gz: d37e67f5acbe6096cb0c8434cdd6fe22beb947a3de2338f4d66c3f7794d2df9dfecee6b389c159363c8dc568bc4ad7858d24322495e3243367947c60f61cc0e3
+  metadata.gz: f6dea096242a5d412dbe09773b2e31135bbd98e31d375475eb7b4f337d2cebe0c242dae5a7bfd401bee00ec969d6383e636ed0ebb10957e00e6916516a3a7543
+  data.tar.gz: cd95a588cd1f2a65e0a22838f12183e2e281bf3fb0a8e080c6d8095d8e4d2654ecd0d50d46dca0c3a0d2bb4ebea534c6c91b93f5866d4e2bd940a2e285ba316e

data/lib/circuit_client/client.rb

@@ -10,15 +10,19 @@ module CircuitClient
   # client for accessing circuit API
   class Client
     # Set the hostname of the circuit system
+    # Default: eu.yourcircuit.com
     attr_accessor :host
 
     # The base path of the API
+    # Default: /rest/v2
     attr_accessor :base_path
 
     # The protocol to use 'http' or 'https'
+    # Default: 'https'
     attr_accessor :protocol
 
     # Timeout for http requests
+    # Default: 60
     attr_accessor :timeout
 
     # The client_id for authentication
@@ -30,7 +34,13 @@ module CircuitClient
     # The authentication method to use (currently only :client_credentials supported)
     attr_accessor :auth_method
 
+    # Comma-delimited set of permissions that the application requests
+    # ALL, READ_USER_PROFILE, WRITE_USER_PROFILE, READ_CONVERSATIONS, WRITE_CONVERSATIONS, READ_USER, CALLS
+    # Default: ALL
+    attr_accessor :auth_scope
+
     # Enable tracing (outputs http requests to STDOUT)
+    # Default: false (disabled)
     attr_accessor :trace
 
     # Initialize a new client
@@ -48,6 +58,7 @@ module CircuitClient
       @base_path = '/rest/v2'
       @protocol = 'https'
       @auth_method = :client_credentials
+      @auth_scope = 'ALL'
       @timeout = 60
       @trace = false
       yield self
@@ -81,7 +92,7 @@ module CircuitClient
         client_id: @client_id,
         client_secret: @client_secret,
         grant_type: 'client_credentials',
-        scope: 'ALL',
+        scope: @auth_scope,
       } )
       data = JSON.parse(response.body)
       data['access_token']

data/lib/circuit_client/errors.rb

@@ -7,7 +7,7 @@ module CircuitClient
       if !content_type.nil? && content_type.match(/application\/json/)
         begin
           error = JSON.parse(ex[:body])
-          super("server response: #{error['errorDescription']} (status: #{ex[:status]})")
+          super("server response: #{error['errorDescription'] || error} (status: #{ex[:status]})")
         rescue JSON::ParserError
           super("server response with status #{ex[:status]} and malformed JSON")
         end

data/lib/circuit_client/send_message_cli.rb

@@ -4,17 +4,19 @@ require 'yaml'
 
 module CircuitClient
   class SendMessageCli
-
     class Config
       DEFAULTS = {
         timeout: 60,
         host: 'eu.yourcircuit.com',
         client_id: nil,
         client_secret: nil,
+        auth_scope: 'ALL'
       }
+
       def self.load_config(path)
         @@data = YAML.load_file(path)
       end
+
       def self.method_missing(method_name)
         if DEFAULTS.has_key?(method_name)
           @@data[method_name.to_s] || DEFAULTS[method_name]
@@ -61,37 +63,37 @@ END_USAGE
 
     def getopts
       opts = GetoptLong.new(
-        [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
-        [ '--conversation', '-c', GetoptLong::REQUIRED_ARGUMENT ],
-        [ '--subject', '-s', GetoptLong::REQUIRED_ARGUMENT ],
-        [ '--topic', '-t', GetoptLong::REQUIRED_ARGUMENT ],
-        [ '--trace', GetoptLong::NO_ARGUMENT ],
-        [ '--list', '-l', GetoptLong::NO_ARGUMENT ],
-        [ '--new', '-n', GetoptLong::NO_ARGUMENT ],
-        [ '--participant', '-p', GetoptLong::REQUIRED_ARGUMENT ],
-        [ '--config', '-f', GetoptLong::REQUIRED_ARGUMENT ],
+        ['--help', '-h', GetoptLong::NO_ARGUMENT],
+        ['--conversation', '-c', GetoptLong::REQUIRED_ARGUMENT],
+        ['--subject', '-s', GetoptLong::REQUIRED_ARGUMENT],
+        ['--topic', '-t', GetoptLong::REQUIRED_ARGUMENT],
+        ['--trace', GetoptLong::NO_ARGUMENT],
+        ['--list', '-l', GetoptLong::NO_ARGUMENT],
+        ['--new', '-n', GetoptLong::NO_ARGUMENT],
+        ['--participant', '-p', GetoptLong::REQUIRED_ARGUMENT],
+        ['--config', '-f', GetoptLong::REQUIRED_ARGUMENT],
       )
       opts.each do |opt, arg|
         case opt
-          when '--help'
-            usage
-            exit 0
-          when '--conversation'
-            @conversation = arg.to_s
-          when '--subject'
-            @subject = arg.to_s
-          when '--trace'
-            @trace = true
-          when '--list'
-            @list = true
-          when '--new'
-            @new = true
-          when '--participant'
-            @participants << arg.to_s
-          when '--config'
-            @config_file = arg.to_s
-          when '--topic'
-            @topic = arg.to_s
+        when '--help'
+          usage
+          exit 0
+        when '--conversation'
+          @conversation = arg.to_s
+        when '--subject'
+          @subject = arg.to_s
+        when '--trace'
+          @trace = true
+        when '--list'
+          @list = true
+        when '--new'
+          @new = true
+        when '--participant'
+          @participants << arg.to_s
+        when '--config'
+          @config_file = arg.to_s
+        when '--topic'
+          @topic = arg.to_s
         end
       end
     end
@@ -109,7 +111,7 @@ END_USAGE
       body = $stdin.readlines.join
 
       if @new == true
-        puts "creating new group conversation..."
+        puts 'creating new group conversation...'
         conv = client.create_group_conversation(@participants, @topic)['convId']
       else
         conv = @conversation
@@ -119,7 +121,7 @@ END_USAGE
       options[:subject] = @subject unless @subject.nil?
       puts "sending message to #{conv}..."
       begin
-        client.create_message( conv, body, **options )
+        client.create_message(conv, body, **options)
       rescue CircuitClient::ClientError => e
         puts "Could not send message: #{e.message}"
         exit 1
@@ -131,6 +133,7 @@ END_USAGE
         c.host = Config.host
         c.client_id = Config.client_id
         c.client_secret = Config.client_secret
+        c.auth_scope = Config.auth_scope
         c.trace = @trace
         c.timeout = Config.timeout
       end
@@ -141,7 +144,5 @@ END_USAGE
         puts "- #{c['topic']} (#{c['convId']})"
       end
     end
-
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit_client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Markus Benning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake