circuit_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8e1508915ce91398ef199c6f21c03eb84f0c614
+  data.tar.gz: b94c3dd4990da34a3ac0b34a7ea5d7869214c1b2
+SHA512:
+  metadata.gz: 177e67970945a50d5468c57adcb8530d24096b877113a048f731b2d1265f95bdc32f4675bc10ced3a1e6936040ccc2e3e5a409db8d632899acf73c939c34f7ae
+  data.tar.gz: 19b15b3cfb43e6799cfa2676888a2017fdfd1cb26de7c4f0b7341316ef939da1a1798ab479fb97336eb3234ae4f6258e04f7556cf15b8d7368db5d6a8a321043

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.4
+
+WORKDIR /usr/src/module
+
+COPY Gemfile* ./
+RUN bundle install
+
+COPY . .
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/README.md

@@ -0,0 +1,58 @@
+# Circuit Client
+
+circuit\_client is a minimal client for the Circuit REST API.
+
+* [Circuit](https://www.circuit.com/)
+* [Circuit REST API](https://circuitsandbox.net/rest/v2/swagger/ui/index.html)
+
+It is not a full-featured API client and current only supports:
+
+ * only client\_credentials authentication
+ * list and create conversations
+ * create new messages
+
+## API Documentation
+
+Available at [rubydoc.info](http://www.rubydoc.info/gems/circuit_client).
+
+## Usage
+
+### Basic usage
+
+```ruby
+require 'circuit_client'
+
+client = CircuitClient::Client.new do |c|
+  c.client_id = '<client_id>'
+  c.client_secret = '<client_secret>'
+end
+
+client.create_message('<convId>', 'Hello World!')
+```
+
+## Command line interface
+
+The `send-circuit` command shipped with circuit\_client has the following options:
+
+```
+Usage: send-circuit [OPTIONS]
+  --help | -h                display this help text
+  --config | -c <file>       path to configuration file
+                             (default: /etc/send-circuit.yaml)
+  --trace                    print http debug information
+
+List conversations:
+  --list | -l                list conversations of user
+
+Send message:
+  --subject | -s <text>      Set subject for message
+
+  --conversation | -c <id>   Id of the conversation to send a message to
+  or
+  --new | -n                 creates a new conversation
+  --topic | -t <text>        topic of the new conversation
+  --participant | -p
+    <email or id>            adds a participant to the conversation
+
+The command will read the message body from stdin.
+```

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'                                                                       
+
+spec = eval(File.read('circuit_client.gemspec'))
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+Rake::RDocTask.new do |rd|
+  rd.rdoc_files.include("lib/**/*.rb","bin/**/*")
+  rd.title = 'Circuit Client for REST API'
+end                                                                                       
+

data/bin/send-circuit

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'circuit_client/send_message_cli'
+
+app = CircuitClient::SendMessageCli.new
+app.run
+

data/lib/circuit_client.rb

@@ -0,0 +1 @@
+require 'circuit_client/client'

data/lib/circuit_client/client.rb

@@ -0,0 +1,190 @@
+require 'faraday'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'uri'
+require 'json'
+
+module CircuitClient
+  class Client
+    # Set the hostname of the circuit system
+    attr_accessor :host
+
+		# The base path of the API
+    attr_accessor :base_path
+
+		# The protocol to use 'http' or 'https'
+    attr_accessor :protocol
+
+		# Timeout for http requests
+    attr_accessor :timeout
+
+		# The client_id for authentication
+    attr_accessor :client_id
+
+		# The client_secret for authentication
+    attr_accessor :client_secret
+
+		# The authentication method to use (currently only :client_credentials supported)
+    attr_accessor :auth_method
+
+		# Enable tracing (outputs http requests to STDOUT)
+		attr_accessor :trace
+
+		# Initialize a new client
+		# 
+    # Examples
+    #
+    #   CircuitClient::Client.new do |c|
+    #     c.client_id = '4de34a3...'
+    #     c.client_secret = '234df2...'
+    #   end
+    #
+    # Returns a new CircuitClient::Client
+    def initialize
+      @host = 'eu.yourcircuit.com'
+      @base_path = '/rest/v2'
+      @protocol = 'https'
+      @auth_method = :client_credentials
+      @timeout = 60
+      @trace = false
+      yield self
+    end
+
+		# The faraday http connection object
+    def connection
+      @connection ||= Faraday.new(url: base_uri.to_s) do |faraday|
+        faraday.response :logger if @trace
+        faraday.use Faraday::Response::RaiseError
+        faraday.adapter :typhoeus
+      end
+    end
+
+		# The token used for authentication
+    def access_token
+      return @access_token unless @access_token.nil?
+      case @auth_method
+      when :client_credentials
+        auth_client_credentials
+      else
+        raise "Unknown auth_method: #{@auth_method}"
+      end
+    end
+
+		# 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?
+      response = connection.post(build_uri('/oauth/token'), {
+        client_id: @client_id,
+        client_secret: @client_secret,
+        grant_type: 'client_credentials',
+        scope: 'ALL',
+      } )
+      data = JSON.parse(response.body)
+      data['access_token']
+    end
+
+		# Return URI with path elements
+    def base_uri
+      URI("#{@protocol}://#{@host}")
+    end
+
+		# 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
+    def build_api_uri(path)
+      build_uri("#{@base_path}#{path}")
+    end
+
+		# Create a new message in a existing conversation
+		#
+		# Examples
+    #
+    #   client.create_message('<convId>', 'my message text...', subject: 'Todays meeting')
+    #
+    def create_message(conv, text, **options)
+      call(:post, "/conversations/#{conv}/messages", {
+        'content' => text,
+        **options,
+      } )
+    end
+
+    # List all conversation of the user
+    def list_conversations
+      call(:get, "/conversations")
+    end
+
+		# Create a new group conversation
+    def create_group_conversation(participants, topic)
+      call(:post, '/conversations/group', {
+        participants: participants,
+        topic: topic,
+      } )
+    end
+
+		# Create a new 1:1 conversation
+    def create_direct_conversation(participant)
+      call(:post, '/conversations/direct', {
+        participant: participant,
+      } )
+    end
+
+		# Remove participants from a conversation
+    def delete_group_conversation_participants(conv, participants)
+      call(:delete, "/conversations/group/#{conv}/participants", {
+        participants: participants,
+      } )
+    end
+
+    # Remove the current_user from a conversation
+    def leave_group_conversation(conv)
+      delete_group_conversation_participants(conv, [current_user['userId']])
+    end
+
+		# Get the profile of the connections user
+    def get_user_profile
+      call(:get, "/users/profile")
+    end
+
+    # A cached version of the current connections user profile
+    def current_user
+      @current_user ||= get_user_profile
+    end
+
+		# Get profile of a user
+    def get_users(id)
+      call(:get, "/users/#{id}")
+    end
+
+		# Get presence information of a user
+    def get_users_presence(id)
+      call(:get, "/users/#{id}/presence")
+    end
+
+		private
+
+    def call(method, path, payload = {}, headers = {})
+      response = connection.send(method) do |req|
+        req.url build_api_uri(path)
+        req.options.timeout = @timeout
+        req.headers['Accept'] = 'application/json'
+        req.headers['Authorization'] = "Bearer #{access_token}"
+        case method
+        when :post
+          req.body = payload.to_json
+          req.headers['Content-Type'] = 'application/json'
+        when :get, :delete
+          req.params = payload
+        end
+      end
+      return JSON.parse(response.body) if response.success?
+    end
+
+  end
+end
+

data/lib/circuit_client/send_message_cli.rb

@@ -0,0 +1,142 @@
+require 'circuit_client'
+require 'getoptlong'
+require 'yaml'
+
+module CircuitClient
+  class SendMessageCli
+
+    class Config
+      DEFAULTS = {
+        timeout: 60,
+        host: 'eu.yourcircuit.com',
+        client_id: nil,
+        client_secret: nil,
+      }
+      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]
+        else
+          super
+        end
+      end
+    end
+
+    def initialize
+      @trace = false
+      @list = false
+      @new = false
+      @participants = []
+      @config_file = '/etc/send-circuit.yaml'
+      @topic = ''
+    end
+
+    def usage
+      puts <<-END_USAGE
+Usage: send-circuit [OPTIONS]
+  --help | -h                display this help text
+  --config | -c <file>       path to configuration file
+                             (default: /etc/send-circuit.yaml)
+  --trace                    print http debug information
+
+List conversations:
+  --list | -l                list conversations of user
+
+Send message:
+  --subject | -s <text>      Set subject for message
+
+  --conversation | -c <id>   Id of the conversation to send a message to
+  or
+  --new | -n                 creates a new conversation
+  --topic | -t <text>        topic of the new conversation
+  --participant | -p
+    <email or id>            adds a participant to the conversation
+
+
+The command will read the message body from stdin.
+END_USAGE
+    end
+
+    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 ],
+      )
+      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
+        end
+      end
+    end
+
+    def run
+      getopts
+      Config.load_config(@config_file)
+
+      if @list == true
+        list_conversations
+        exit 0
+      end
+
+      # read msg from stdin
+      body = $stdin.readlines.join
+
+      if @new == true
+        puts "creating new group conversation..."
+        conv = client.create_group_conversation(@participants, @topic)['convId']
+      else
+        conv = @conversation
+      end
+
+      options = {}
+      options[:subject] = @subject unless @subject.nil?
+      puts "sending message to #{conv}..."
+      client.create_message( conv, body, **options )
+    end
+
+    def client
+      CircuitClient::Client.new do |c|
+        c.host = Config.host
+        c.client_id = Config.client_id
+        c.client_secret = Config.client_secret
+        c.trace = @trace
+        c.timeout = Config.timeout
+      end
+    end
+
+    def list_conversations
+      client.list_conversations.each do |c|
+        puts "- #{c['topic']} (#{c['convId']})"
+      end
+    end
+
+  end
+end
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: circuit_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Markus Benning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: ich@markusbenning.de
+executables:
+- send-circuit
+extensions: []
+extra_rdoc_files: []
+files:
+- Dockerfile
+- Gemfile
+- README.md
+- Rakefile
+- bin/send-circuit
+- lib/circuit_client.rb
+- lib/circuit_client/client.rb
+- lib/circuit_client/send_message_cli.rb
+homepage: https://github.com/benningm/circuit_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Simple client for circuit REST API
+test_files: []