komonjo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3f1a6dd632f13cdf283ef1c850ebdea0659a607
+  data.tar.gz: 736f46282d66595aa22839ce3d90f68b539a88c6
+SHA512:
+  metadata.gz: 9d896f691aa414e3a6f6a9d87ea77ccb230ef4d7ef222893340315fb9a7b4d9dc1e21687b07c9e4e8277a289e379ea79146346f8200e6dd54ac93c46ade12b91
+  data.tar.gz: 832a69b6ceb1b93d6afea95b33214702d8e9d67c0c0b266fb5317de5bf1c1383f6526df00f76a421ef3c236b5cd1cac115cba7f620733756c4baebddb6f0b961

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 hkdnet
+
+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 NONINFRINGEMENT. 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,50 @@
+# Komonjo
+
+A Slack client wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'komonjo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install komonjo-ruby
+
+## Usage
+
+```ruby
+client = Komonjo::Client.new(your_slack_token)
+
+# checking connection
+client.token_valid?
+
+# get channels
+client.channels
+
+# get message at a channel
+# Note: The argument is not channel_id but channel_name
+client.messages(channel_name)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hkdnet/komonjo-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "komonjo"
+
+# 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/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/komonjo.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'komonjo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "komonjo"
+  spec.version       = Komonjo::VERSION
+  spec.authors       = ["hkdnet"]
+  spec.email         = ["hkdnet@users.noreply.github.com"]
+
+  spec.summary       = %q{A Slack client wrapper.}
+  spec.description   = %q{A Slack client wrapper.}
+  spec.homepage      = "https://github.com/hkdnet/komonjo-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "slack-api", "~> 1.1.6"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-power_assert", "~> 0.2.0"
+end

data/lib/komonjo.rb

@@ -0,0 +1,16 @@
+require 'komonjo/client'
+require 'komonjo/version'
+require 'komonjo/connections/slack_connection'
+require 'komonjo/extensions/hash_extensions'
+require 'komonjo/extensions/to_json'
+require 'komonjo/gateways/channels_gateway'
+require 'komonjo/gateways/messages_gateway'
+require 'komonjo/models/api/response_base'
+require 'komonjo/models/channel'
+require 'komonjo/models/message'
+require 'komonjo/models/profile'
+require 'komonjo/models/user'
+require 'komonjo/services/slack_service'
+require 'komonjo/services/channels_service'
+require 'komonjo/services/login_service'
+require 'komonjo/services/messages_service'

data/lib/komonjo/client.rb

@@ -0,0 +1,22 @@
+module Komonjo
+  class Client
+    def initialize(api_token)
+      @api_token = api_token
+    end
+
+    def token_valid?
+      s = Komonjo::Service::LoginService.new(@api_token)
+      s.login
+    end
+
+    def channels
+      s = Komonjo::Service::ChannelsService.new(@api_token)
+      s.channels
+    end
+
+    def messages(channel_name)
+      s = Komonjo::Service::MessagesService.new(@api_token)
+      s.messages(channel_name)
+    end
+  end
+end

data/lib/komonjo/connections/slack_connection.rb

@@ -0,0 +1,59 @@
+require 'slack'
+
+module Komonjo
+  module Connection
+    # Connection for slack
+    class SlackConnection
+      attr_reader :client
+      def initialize(api_token)
+        @client = Slack::Client.new(token: api_token)
+      end
+
+      def channels_history(channel_name)
+        channel_name[0] = '' if channel_name[0] == '#'
+        channel_id = channel_id channel_name
+        ret = client.channels_history(channel: channel_id)
+        fail 'error' unless ret['ok']
+        ret['messages']
+      end
+
+      def users_info(user_id)
+        ret = client.users_info(user: user_id)
+        fail 'error' unless ret['ok']
+        ret['user']
+      end
+
+      def users_list
+        ret = client.users_list
+        fail 'error' unless ret['ok']
+        ret['members']
+      end
+
+      def channels_list
+        ret = client.channels_list
+        fail 'error' unless ret['ok']
+        ret['channels']
+      end
+
+      def auth_test
+        ret = client.auth_test
+        ret['ok']
+      end
+
+      private
+
+      def channel_id(channel_name)
+        channel_list = Slack.channels_list
+        fail 'error' unless channel_list['ok']
+        target_channel = channel_list['channels'].select do |e|
+          e['name'] == channel_name
+        end
+        if target_channel.empty?
+          fail "unknown channel name: #{channel_name}"
+        else
+          target_channel.first['id']
+        end
+      end
+    end
+  end
+end

data/lib/komonjo/extensions/hash_extensions.rb

@@ -0,0 +1,8 @@
+# allow accsess with symbol key
+module HashExtensions
+  refine Hash do
+    def symbolize_keys
+      map { |k, v| [k.to_sym, v] }
+    end
+  end
+end

data/lib/komonjo/extensions/to_json.rb

@@ -0,0 +1,16 @@
+module Komonjo
+  module Extension
+    # generate to_json method
+    module ToJson
+      def to_json(*args)
+        ret = instance_variables.each_with_object({}) do |attr, hash|
+          # remove head @
+          key = attr.to_s
+          key[0] = ''
+          hash[key.to_sym] = instance_variable_get(attr)
+        end
+        ret.to_json(*args)
+      end
+    end
+  end
+end

data/lib/komonjo/gateways/channels_gateway.rb

@@ -0,0 +1,15 @@
+module Komonjo
+  module Gateway
+    # Merge history and users
+    class ChannelsGateway
+      using HashExtensions
+      def initialize(channels)
+        @channels = channels.map { |e| Hash[e.symbolize_keys] }
+      end
+
+      def channels
+        @channels.map { |e| Komonjo::Model::Channel.create(e) }
+      end
+    end
+  end
+end

data/lib/komonjo/gateways/messages_gateway.rb

@@ -0,0 +1,36 @@
+require 'cgi'
+
+module Komonjo
+  module Gateway
+    # Merge history and users
+    class MessagesGateway
+      using HashExtensions
+      def initialize(history, users)
+        @history = history.map { |e| Hash[e.symbolize_keys] }
+        @users = users.map do |e|
+          ret = Hash[e.symbolize_keys]
+          ret[:profile] = Hash[ret[:profile].symbolize_keys]
+          ret
+        end
+      end
+
+      def messages
+        @history.map do |e|
+          next e unless e[:user]
+          Komonjo::Model::Message.create(e).tap do |message|
+            message.user = find_user(e[:user])
+            message.text = CGI.unescapeHTML(message.text)
+          end
+        end
+      end
+
+      private
+
+      def find_user(user_id)
+        user = @users.find { |e| e[:id] == user_id }
+        fail "unknown user: #{user_id}" unless user
+        Komonjo::Model::User.create(user)
+      end
+    end
+  end
+end

data/lib/komonjo/mocks/slack_mock.rb

@@ -0,0 +1,84 @@
+module Komonjo
+  module Mock
+    # Mock for SlackConnection
+    class SlackMock
+      class << self
+        def chat_logs
+          g = Komonjo::Gateway::MessagesGateway.new(channels_history('test'),
+                                                    users_list)
+          g.messages
+        end
+
+        def users_list
+          [{ id: 'id001', name: 'name001', deleted: false,
+             profile: { image_48: '' } },
+           { id: 'id002', name: 'name002', deleted: false,
+             profile: { image_48: '' } }]
+        end
+
+        def channels_history(channel_name)
+          [{ type: 'message', user: 'id001', channel: channel_name,
+             text: 'Hello, world' },
+           { type: 'message', user: 'id002', channel: channel_name,
+             text: 'This is Komonjo' }]
+        end
+
+        def channels_list
+          [{
+            'id': 'C024BE91L',
+            'name': 'channel1',
+            'is_channel': 'true',
+            'created': 1_360_782_804,
+            'creator': 'U024BE7LH',
+            'is_archived': false,
+            'is_general': false,
+            'members': %w(U024BE7LH U024BE7LH),
+            'topic': {
+              'value': 'Fun times',
+              'creator': 'U024BE7LV',
+              'last_set': 1_369_677_212
+            },
+            'purpose': {
+              'value': 'This channel is for fun',
+              'creator': 'U024BE7LH',
+              'last_set': 1_360_782_804
+            },
+            'is_member': true,
+            'last_read': '1401383885.000061',
+            'latest': {
+              'hoge': 'fuga'
+            },
+            'unread_count': 0,
+            'unread_count_display': 0
+          }, {
+            'id': 'C024BE91L',
+            'name': 'channel1',
+            'is_channel': 'true',
+            'created': 1_360_782_804,
+            'creator': 'U024BE7LH',
+            'is_archived': false,
+            'is_general': false,
+            'members': %w(U024BE7LH U024BE7LH),
+            'topic': {
+              'value': 'Fun times',
+              'creator': 'U024BE7LV',
+              'last_set': 1_369_677_212
+            },
+            'purpose': {
+              'value': 'This channel is for fun',
+              'creator': 'U024BE7LH',
+              'last_set': 1_360_782_804
+            },
+            'is_member': true,
+            'last_read': '1401383885.000061',
+            'latest': {
+              'hoge': 'fuga'
+            },
+            'unread_count': 0,
+            'unread_count_display': 0
+          }]
+        end
+      end
+    end
+  end
+end

data/lib/komonjo/models/api/response_base.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+module Komonjo
+  module Model
+    module API
+      # api response base class
+      class ResponseBase
+        attr_accessor :ok, :message, :data
+
+        def initialize
+          @ok = true
+          @message = ''
+        end
+
+        def to_json
+          hash = {}
+          hash[:ok] = @ok
+          hash[:message] = @message
+          hash[:data] = @data
+          JSON[hash]
+        end
+      end
+    end
+  end
+end

data/lib/komonjo/models/channel.rb

@@ -0,0 +1,16 @@
+module Komonjo
+  module Model
+    # slacke channel
+    class Channel
+      attr_accessor :id, :name, :is_channel, :created, :creator, :is_archived,
+                    :is_general, :members, :topic, :purpose, :is_member,
+                    :last_read, :latest, :unread_count, :unread_count_display
+
+      def self.create(hash)
+        new.tap do |e|
+          hash.each { |k, v| e.instance_variable_set("@#{k}", v) }
+        end
+      end
+    end
+  end
+end

data/lib/komonjo/models/message.rb

@@ -0,0 +1,47 @@
+module Komonjo
+  module Model
+    # slacke Message
+    class Message
+      include Komonjo::Extension::ToJson
+      attr_accessor :type, :channel, :user, :text, :ts, :edited, :subtype
+      # for jsonize
+      attr_reader :markdown
+      alias_method :to_json_org, :to_json
+
+      def self.create(hash)
+        new.tap do |e|
+          hash.each { |k, v| e.instance_variable_set("@#{k}", v) }
+        end
+      end
+
+      def timestamp
+        Time.at(@ts.to_f).strftime('%Y-%m-%d %H:%M:%S')
+      end
+
+      def to_markdown
+        icon_markdown + name_markdown + ts_markdown + text_markdown
+      end
+
+      def icon_markdown
+        "* ![#{@user.name} icon](#{@user.profile.image_48})\n"
+      end
+
+      def name_markdown
+        "\t- #{@user.name}\n"
+      end
+
+      def ts_markdown
+        "\t- #{timestamp}\n"
+      end
+
+      def text_markdown
+        "\t- #{@text}\n"
+      end
+
+      def to_json(*args)
+        @markdown = to_markdown
+        to_json_org(args)
+      end
+    end
+  end
+end

data/lib/komonjo/models/profile.rb

@@ -0,0 +1,15 @@
+module Komonjo
+  module Model
+    # slack User.profile
+    class Profile
+      include Komonjo::Extension::ToJson
+
+      attr_accessor :first_name, :last_name, :real_name, :email, :skype, :phone,
+                    :image_24, :image_32, :image_48, :image_72, :image_192
+
+      def self.create(hash)
+        new.tap { |e| hash.each { |k, v| e.instance_variable_set("@#{k}", v) } }
+      end
+    end
+  end
+end

data/lib/komonjo/models/user.rb

@@ -0,0 +1,19 @@
+module Komonjo
+  module Model
+    # slack user
+    class User
+      include Komonjo::Extension::ToJson
+
+      attr_accessor :profile, :id, :name, :deleted, :color, :is_admin,
+                    :is_owner, :is_primary_owner, :is_restricted,
+                    :is_ultra_restricted, :has_2fa, :has_files
+
+      def self.create(hash)
+        new.tap do |e|
+          hash.each { |k, v| e.instance_variable_set("@#{k}", v) }
+          e.profile = Profile.create(hash[:profile]) if hash[:profile]
+        end
+      end
+    end
+  end
+end

data/lib/komonjo/services/channels_service.rb

@@ -0,0 +1,17 @@
+module Komonjo
+  module Service
+    # A service for get channels_list as Komonjo::Model::Channel
+    class ChannelsService < Komonjo::Service::SlackService
+      def initialize(api_token)
+        @api_token = api_token
+      end
+
+      def channels
+        connection = connection(@api_token)
+        raw_channels = connection.channels_list
+        gateway = Komonjo::Gateway::ChannelsGateway.new raw_channels
+        gateway.channels
+      end
+    end
+  end
+end

data/lib/komonjo/services/login_service.rb

@@ -0,0 +1,15 @@
+module Komonjo
+  module Service
+    # A service for get channels_list as Komonjo::Model::Channel
+    class LoginService < Komonjo::Service::SlackService
+      def initialize(api_token)
+        @api_token = api_token
+      end
+
+      def login
+        connection = connection(@api_token)
+        connection.auth_test
+      end
+    end
+  end
+end

data/lib/komonjo/services/messages_service.rb

@@ -0,0 +1,18 @@
+module Komonjo
+  module Service
+    # A service for merge channel log and user information
+    class MessagesService < Komonjo::Service::SlackService
+      def initialize(api_token)
+        @api_token = api_token
+      end
+
+      def messages(channel_name)
+        connection = connection(@api_token)
+        history = connection.channels_history channel_name
+        users = connection.users_list
+        gateway = Komonjo::Gateway::MessagesGateway.new history, users
+        gateway.messages
+      end
+    end
+  end
+end

data/lib/komonjo/services/slack_service.rb

@@ -0,0 +1,10 @@
+module Komonjo
+  module Service
+    # A base class for Service of Slack
+    class SlackService
+      def connection(api_token)
+        @connection ||= Komonjo::Connection::SlackConnection.new(api_token)
+      end
+    end
+  end
+end

data/lib/komonjo/version.rb

@@ -0,0 +1,3 @@
+module Komonjo
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: komonjo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hkdnet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: A Slack client wrapper.
+email:
+- hkdnet@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- komonjo.gemspec
+- lib/komonjo.rb
+- lib/komonjo/client.rb
+- lib/komonjo/connections/slack_connection.rb
+- lib/komonjo/extensions/hash_extensions.rb
+- lib/komonjo/extensions/to_json.rb
+- lib/komonjo/gateways/channels_gateway.rb
+- lib/komonjo/gateways/messages_gateway.rb
+- lib/komonjo/mocks/slack_mock.rb
+- lib/komonjo/models/api/response_base.rb
+- lib/komonjo/models/channel.rb
+- lib/komonjo/models/message.rb
+- lib/komonjo/models/profile.rb
+- lib/komonjo/models/user.rb
+- lib/komonjo/services/channels_service.rb
+- lib/komonjo/services/login_service.rb
+- lib/komonjo/services/messages_service.rb
+- lib/komonjo/services/slack_service.rb
+- lib/komonjo/version.rb
+homepage: https://github.com/hkdnet/komonjo-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.5.1
+signing_key: 
+specification_version: 4
+summary: A Slack client wrapper.
+test_files: []
+has_rdoc: