rocketchat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 762d05d1acfbb58cc5b20516868c034f7c09903b
+  data.tar.gz: c58f16cc9e678a8d31da53419c6f785b8f4a43b6
+SHA512:
+  metadata.gz: 03184b8414ab04854cf5b8ff0cda1d445ad006dc099b60bc065e7d2eca6c8a50037010d4ce9668fbb217a7c024d74dfc3e663ab5e9754408f5d0e0436fbd6b31
+  data.tar.gz: 1555a4eb6a1c90524dc19712acb4085bb05533703f9757ef71d955b95a984d0f6e9b9d583ffaca732ff66df122a48c24104fe4ef8601c6b9438f89cf60e83b7d

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rocketchat.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2016 int512
+Copyright (c) 2017 Andrew Bromwich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Rocket.Chat REST API for Ruby
+
+This is a gem wrapping the v1 REST API for [Rocket.Chat](https://rocket.chat/).
+
+The gem is based on a fork of int2xx9/ruby-rocketchat however that gem implemented v0.1
+of the Rocket.Chat API and it was not forward compatible. Thanks to @int2xx9 for the
+framework on which this gem was based 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rocketchat'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Supported API calls
+
+This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.5.4)
+
+#### Miscellaneous information
+* /api/v1/info
+
+#### Authentication
+* /api/v1/login
+* /api/v1/logout
+
+
+## Usage
+
+To get Rocket.Chat version
+
+```ruby
+require 'rocketchat'
+
+rocket_server = RocketChat::Server.new('http://your.server.address/')
+info = rocket_server.info
+puts "Rocket.Chat version: #{info.version}"
+```
+
+
+To logout from a server:
+
+```ruby
+require 'rocketchat'
+
+rocket_server = RocketChat::Server.new('http://your.server.address/')
+session = rocket_server.login('username', 'password')
+# ... use the API ...
+session.logout
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abrom/rocketchat-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rocketchat'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/lib/rocket_chat/error.rb

@@ -0,0 +1,6 @@
+module RocketChat
+  class Error < StandardError; end
+  class HTTPError < Error; end
+  class InvalidMethodError < HTTPError; end
+  class StatusError < Error; end
+end

data/lib/rocket_chat/gem_version.rb

@@ -0,0 +1,3 @@
+module RocketChat
+  VERSION = '0.0.1'.freeze
+end

data/lib/rocket_chat/info.rb

@@ -0,0 +1,30 @@
+module RocketChat
+  #
+  # Rocket.Chat Info
+  #
+  class Info
+    # Raw info data
+    attr_reader :data
+
+    #
+    # @param [Hash] data Raw version data
+    #
+    def initialize(data)
+      @data = data.dup.freeze
+    end
+
+    # Rocket.Chat version
+    def version
+      @data['version']
+    end
+
+    def inspect
+      format(
+        '#<%s:0x%p @version="%s">',
+        self.class.name,
+        object_id,
+        version
+      )
+    end
+  end
+end

data/lib/rocket_chat/request_helper.rb

@@ -0,0 +1,98 @@
+module RocketChat
+  #
+  # Rocket.Chat HTTP request helper
+  #
+  module RequestHelper
+    DEFAULT_REQUEST_OPTIONS = {
+      method: :get,
+      body: nil,
+      headers: nil,
+      ssl_verify_mode: OpenSSL::SSL::VERIFY_PEER,
+      ssl_ca_file: nil
+    }.freeze
+
+    # Server URI
+    attr_reader :server
+
+    def server=(server)
+      @server = server.is_a?(URI) ? server : URI.parse(server.to_s)
+    end
+
+    def request_json(path, options = {})
+      fail_unless_ok = options.delete :fail_unless_ok
+      response = request path, options
+
+      if fail_unless_ok && !response.is_a?(Net::HTTPOK)
+        raise RocketChat::HTTPError, "Invalid http response code: #{response.code}"
+      end
+
+      response_json = JSON.parse(response.body)
+      unless response_json['status'] == 'success'
+        raise RocketChat::StatusError, response_json['message']
+      end
+
+      response_json
+    end
+
+    def request(path, options = {})
+      options = DEFAULT_REQUEST_OPTIONS.merge(options)
+
+      raise RocketChat::InvalidMethodError unless %i[get post].include? options[:method]
+
+      http = create_http(options)
+      req = create_request(path, options)
+      http.start { http.request(req) }
+    end
+
+    private
+
+    def get_headers(options)
+      headers = options[:headers]
+
+      token = options.delete :token
+      if token
+        headers ||= {}
+
+        headers['X-Auth-Token'] = token.auth_token
+        headers['X-User-Id'] = token.user_id
+      end
+
+      return unless headers
+      headers = Util.stringify_hash_keys headers
+      headers.delete_if { |key, value| key.nil? || value.nil? }
+    end
+
+    def create_http(options)
+      http = Net::HTTP.new(server.host, server.port)
+
+      if server.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = options[:ssl_verify_mode]
+        http.ca_file = options[:ssl_ca_file] if options[:ssl_ca_file]
+      end
+
+      http
+    end
+
+    def create_request(path, options)
+      headers = get_headers(options)
+
+      req = Net::HTTP.const_get(options[:method].to_s.capitalize).new(path, headers)
+
+      body = options[:body]
+      req.body = url_encode(body) unless body.nil?
+
+      req
+    end
+
+    def url_encode(body)
+      if body.is_a?(Hash)
+        body.map do |key, value|
+          "#{URI.escape(key.to_s)}=#{URI.escape(value.to_s)}"
+        end.join('&')
+      else
+        body.to_s
+      end
+    end
+  end
+end

data/lib/rocket_chat/server.rb

@@ -0,0 +1,49 @@
+module RocketChat
+  #
+  # Rocket.Chat Server
+  #
+  class Server
+    include RocketChat::RequestHelper
+
+    # Server options
+    attr_reader :options
+
+    #
+    # @param [URI, String] server Server URI
+    # @param [Hash] options Server options
+    #
+    def initialize(server, options = {})
+      self.server = server
+      @options = options
+    end
+
+    #
+    # Info REST API
+    # @return [Info] Rocket.Chat Info
+    # @raise [HTTPError, StatusError]
+    #
+    def info
+      response = request_json '/api/v1/info', fail_unless_ok: true
+      Info.new response['info']
+    end
+
+    #
+    # Login REST API
+    # @param [String] username Username
+    # @param [String] password Password
+    # @return [Session] Rocket.Chat Session
+    # @raise [HTTPError, StatusError]
+    #
+    def login(username, password)
+      response = request_json(
+        '/api/v1/login',
+        method: :post,
+        body: {
+          username: username,
+          password: password
+        }
+      )
+      Session.new self, Token.new(response['data'])
+    end
+  end
+end

data/lib/rocket_chat/session.rb

@@ -0,0 +1,30 @@
+module RocketChat
+  #
+  # Rocket.Chat Session
+  #
+  class Session
+    # Server
+    attr_reader :server
+    # Session token
+    attr_reader :token
+
+    #
+    # @param [Server] server Server
+    # @param [Token] token Session token
+    #
+    def initialize(server, token)
+      @server = server
+      @token = token.dup.freeze
+    end
+
+    #
+    # logout REST API
+    # @return [NilClass]
+    # @raise [HTTPError, StatusError]
+    #
+    def logout
+      server.request_json('/api/v1/logout', method: :post, token: token)
+      nil
+    end
+  end
+end

data/lib/rocket_chat/token.rb

@@ -0,0 +1,36 @@
+module RocketChat
+  #
+  # Rocket.Chat Token
+  #
+  class Token
+    # Raw token data
+    attr_reader :data
+
+    #
+    # @param [Hash] data Raw token data
+    #
+    def initialize(data)
+      @data = Util.stringify_hash_keys data
+    end
+
+    # Authentication token
+    def auth_token
+      @data['authToken']
+    end
+
+    # User ID
+    def user_id
+      @data['userId']
+    end
+
+    def inspect
+      format(
+        '#<%s:0x%p @auth_token="%s", @user_id="%s">',
+        self.class.name,
+        object_id,
+        auth_token,
+        user_id
+      )
+    end
+  end
+end

data/lib/rocket_chat/util.rb

@@ -0,0 +1,20 @@
+module RocketChat
+  #
+  # Rocket.Chat generic utility functions
+  #
+  module Util
+    #
+    # Stringify symbolized hash keys
+    # @param [Hash] hash A string/symbol keyed hash
+    # @return Stringified hash
+    #
+    def stringify_hash_keys(hash)
+      newhash = {}
+      hash.each do |key, value|
+        newhash[key.to_s] = value
+      end
+      newhash
+    end
+    module_function :stringify_hash_keys
+  end
+end

data/lib/rocketchat.rb

@@ -0,0 +1,12 @@
+require 'rocket_chat/gem_version'
+
+require 'json'
+
+require 'rocket_chat/error'
+require 'rocket_chat/util'
+require 'rocket_chat/request_helper'
+
+require 'rocket_chat/server'
+require 'rocket_chat/session'
+require 'rocket_chat/info'
+require 'rocket_chat/token'

data/rocketchat.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rocket_chat/gem_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rocketchat'
+  spec.version       = RocketChat::VERSION
+  spec.authors       = %w[int512 abrom]
+  spec.email         = %w[github@int512.net a.bromwich@gmail.com]
+
+  spec.summary       = 'Rocket.Chat REST API v1 for Ruby'
+  spec.description   = 'Rocket.Chat REST API v1 for Ruby'
+  spec.homepage      = 'https://github.com/abrom/rocketchat-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 1.24'
+  spec.add_development_dependency 'yard', '~> 0.8.7.6'
+  spec.add_development_dependency 'rubocop', '~> 0.48.1'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rocketchat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- int512
+- abrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+description: Rocket.Chat REST API v1 for Ruby
+email:
+- github@int512.net
+- a.bromwich@gmail.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/rocket_chat/error.rb
+- lib/rocket_chat/gem_version.rb
+- lib/rocket_chat/info.rb
+- lib/rocket_chat/request_helper.rb
+- lib/rocket_chat/server.rb
+- lib/rocket_chat/session.rb
+- lib/rocket_chat/token.rb
+- lib/rocket_chat/util.rb
+- lib/rocketchat.rb
+- rocketchat.gemspec
+homepage: https://github.com/abrom/rocketchat-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- 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.4.8
+signing_key: 
+specification_version: 4
+summary: Rocket.Chat REST API v1 for Ruby
+test_files: []