slack_scratcher 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56b9028533b252ce83872884a332a85d344f7dc0
-  data.tar.gz: 670049b263e5c25aa3222311033546af65dfce6b
+  metadata.gz: d69bdc6dce5f556068fc0e2920cbc511a0197425
+  data.tar.gz: 1bb53fa814baaabff2bc7db34e3a04cb1a7d71a7
 SHA512:
-  metadata.gz: a65adf9dc0a91ad769aabfc1b7cf82133c95f19de544f3f368cdf20ab1444c2986e46928e0f1689dc05f8f0651da514c63174a71d1be2b12bff56b904247f408
-  data.tar.gz: 3ecb3d72f1f036f4c13ae7e706c82c094d75930c2d89d7ee5f8c657e6c0dd9052142df94bb831d021ca8264682825f66a141a981cb4c7982ac89b767eb79b7e4
+  metadata.gz: d23b90ecb37f1babfd251c287e3adef18da56ac8a2aa40ddb075de0c48d902a83121bae2fdb90c0b67fee69e77a54624043f208c87c37ca5cdec60e839a0b86c
+  data.tar.gz: b5776d10ea833e60f774f3e297cbaffcdd7a72692a490a723705d4fe51347127859390b1f62b804b484d0bb4cbbd58b5a5672049649a28b53cb1e61af7124c98

data/lib/slack_scratcher.rb

@@ -5,6 +5,10 @@ require 'faraday'
 
 Dotenv.load
 
+# Importing slack logs from exported fils or API to elasticsearch or
+# other detastores
+#
+# @since 0.0.1
 module SlackScratcher
   autoload :Model, 'slack_scratcher/model'
   autoload :Loader, 'slack_scratcher/loader'
@@ -13,6 +17,8 @@ module SlackScratcher
   autoload :Error, 'slack_scratcher/error'
   autoload :Helper, 'slack_scratcher/helper'
 
+  # logger for SlackScratcher Library
+  # @return [Logger] Ruby standard logger object
   def self.logger
     @logger ||= ::Logger.new(STDOUT)
   end

data/lib/slack_scratcher/adapter.rb

@@ -1,6 +1,9 @@
 module SlackScratcher
+  # SlackScratcher Adapter namespace
+  # @since 0.0.1
   module Adapter
-    autoload :Elasticsearch, 'slack_scratcher/adapter/elasticsearch'
+    autoload :Base, 'slack_scratcher/adapter/base'
     autoload :File, 'slack_scratcher/adapter/file'
+    autoload :Elasticsearch, 'slack_scratcher/adapter/elasticsearch'
   end
 end

data/lib/slack_scratcher/adapter/base.rb

@@ -0,0 +1,27 @@
+module SlackScratcher
+  module Adapter
+    # Abstract adapter class for storing slack logs
+    # @since 0.1
+    class Base
+      # @ abstract
+      def initialize
+        fail NotImplementedError
+      end
+
+      # @ abstract
+      def send
+        fail NotImplementedError
+      end
+
+      # @ abstract
+      def timestamp_of_last_channel_log
+        fail NotImplementedError
+      end
+
+      # @ abstract
+      def ready_index
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/slack_scratcher/adapter/elasticsearch.rb

@@ -2,58 +2,113 @@ require 'elasticsearch'
 
 module SlackScratcher
   module Adapter
-    class Elasticsearch
+    # Elasticsearch adapter for storing slack logs.
+    #
+    # @since 0.0.1
+    # @attr_reader [Elasticsearch::Client] client elasticsearch client
+    class Elasticsearch < SlackScratcher::Adapter::Base
       attr_reader :client
 
+      # Initialize SlackScratcher::Adapter::Elasticsearch object.
+      #
+      # @param [Array] hosts array of Elasticsearch hosts
+      # @param [Hash] metadata metadata for storing
+      # @option metadata [string] :index index for storing
+      # @option metadata [string] :type type for storing
+      #
+      # @example return Elasticsearch adapter object
+      #   hosts = ['http://192.168.59.103:9200']
+      #   metadata = {index: 'slack', type: 'log'}
+      #   SlackScratcher::Adapter::Elastisearch.new(hosts, metadata)
+      #
+      # @return [SlackScratcher::Adapter::Elasticsearh]
+      #   Elasticsearch adapter object
       def initialize(hosts, metadata)
         @client = ::Elasticsearch::Client.new hosts: hosts
         @metadata = metadata
       end
 
+      # Send data into elastisearch host.
+      #
+      # @see http://www.rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions#bulk-instance_method
+      # @param [Array] raw_data slack logs which parsed by loader
+      #
+      # @example Send log from loader to elastisearch adapter
+      #   loader.each { |data| adapter.send data }
+      #
+      # @raise [Elasticsearch::Transport::Transport::Errors::BadRequest]
+      #   It raise when request is fail
+      #
+      # @return [Hash] Deserialized Elasticsearch response
+      # @return [Boolean] If raw_data is empty, it returns false
       def send(raw_data)
         data = format_bulk(raw_data)
         @client.bulk data unless raw_data.empty?
+        false
       rescue ::Elasticsearch::Transport::Transport::Errors::BadRequest => error
         puts error
       end
 
+      # Get last logs' timestamp of specific channel from saved data
+      #
+      # @param [String] channel_name channel name
+      #
+      # @example Get saved last log's timestamp of general channel
+      #   adapter.timestamp_of_last_log 'general' #=> '1426337804.820065'
+      #
+      # @return [String] Timestamp of last log
+      # @return [String] If there isn't saved log, it returns '0'
       def timestamp_of_last_channel_log(channel_name)
         request_body = create_body(query_for_last_log(channel_name))
         log = @client.search request_body
 
-        return 0 if log['hits']['total'] == 0
+        return '0' if log['hits']['total'] == 0
         log['hits']['hits'][0]['_source']['ts']
       end
 
+      # Create index and set mapping for saving slack log data
+      #
+      # @example Create index and set mapping
+      #   adapter.ready_index
+      #
+      # @return [Boolean] If there isn't any problem, it returns true
       def ready_index
         unless index?
           create_index
           put_mapping
         end
+
+        true
       end
 
       private
 
+      # @private
       def index
         @metadata[:index]
       end
 
+      # @private
       def type
         @metadata[:type]
       end
 
+      # @private
       def index?
         @client.indices.exists(index: index)
       end
 
+      # @private
       def create_index
         @client.indices.create(index: index)
       end
 
+      # @private
       def put_mapping
         @client.indices.put_mapping create_body(mapping)
       end
 
+      # @private
       def mapping
         {
           type => {
@@ -72,6 +127,7 @@ module SlackScratcher
         }
       end
 
+      # @private
       def query_for_last_log(channel_name)
         {
           size: 1,
@@ -85,6 +141,7 @@ module SlackScratcher
         }
       end
 
+      # @private
       def create_body(body = {})
         {
           index: index,
@@ -93,10 +150,12 @@ module SlackScratcher
         }
       end
 
+      # @private
       def format_bulk(data)
         { body: data.map { |log| format_log(log) } }
       end
 
+      # @private
       def format_log(log)
         { index:
             {

data/lib/slack_scratcher/adapter/file.rb

@@ -1,7 +1,8 @@
 module SlackScratcher
   module Adapter
-    class File
-
+    # File adapter for storing slack logs.
+    # @note Not yet implemented
+    class File < SlackScratcher::Adapter::Base
     end
   end
 end

data/lib/slack_scratcher/error.rb

@@ -1,4 +1,6 @@
 module SlackScratcher
+  # SlackScratcher Error namespace
+  # @since 0.0.1
   module Error
     autoload :UserNotFoundError, 'slack_scratcher/error/user_not_found_error'
     autoload :SlackApiError, 'slack_scratcher/error/slack_api_error'

data/lib/slack_scratcher/error/file_not_found.rb

@@ -1,5 +1,7 @@
 module SlackScratcher
   module Error
+    # Error which represent FileNotFound
+    # since 0.0.1
     class FileNotFound < StandardError
     end
   end

data/lib/slack_scratcher/error/slack_api_error.rb

@@ -1,5 +1,7 @@
 module SlackScratcher
   module Error
+    # Error which represent SlackApiError
+    # since 0.0.1
     class SlackApiError < StandardError
     end
   end

data/lib/slack_scratcher/error/token_not_set.rb

@@ -1,5 +1,7 @@
 module SlackScratcher
   module Error
+    # Error which represent TokenNotSet
+    # since 0.0.1
     class TokenNotSet < StandardError
     end
   end

data/lib/slack_scratcher/error/user_not_found_error.rb

@@ -1,5 +1,7 @@
 module SlackScratcher
   module Error
+    # Error which represent UserNotFoundError
+    # since 0.0.1
     class UserNotFoundError < StandardError
     end
   end

data/lib/slack_scratcher/helper.rb

@@ -1,8 +1,20 @@
 module SlackScratcher
+  # SlackScratcher helper module
+  # @since 0.0.1
   module Helper
+    # Index data for searching by specific column
+    #
+    # @param [Array<Hash>] dataset Dataset
+    # @param [String] column column key for indexing
+    #
+    # @example Index name column
+    #   data = [{name: 'foo', value: 10}, {name: 'bar', value: 20}]
+    #   indexed_data = helper.index_data(data, :name)
+    #   indexed_data['foo'][:value] == 10 #=> true
+    #
+    # @return [Hash] indexed hash
     def self.index_data(dataset, column)
       dataset.map { |data| { data[column] => data } }.inject({}, :merge)
     end
   end
 end
-

data/lib/slack_scratcher/loader.rb

@@ -1,5 +1,8 @@
 module SlackScratcher
+  # SlackScratcher Loader namespace
+  # @since 0.0.1
   module Loader
+    autoload :Base, 'slack_scratcher/loader/base'
     autoload :File, 'slack_scratcher/loader/file'
     autoload :Api, 'slack_scratcher/loader/api'
   end

data/lib/slack_scratcher/loader/api.rb

@@ -2,15 +2,38 @@ require 'slack'
 
 module SlackScratcher
   module Loader
-    class Api
-      include Enumerable
-
+    # Loader class for importing latest slack logs through Slack API
+    #
+    # @since 0.1
+    class Api < SlackScratcher::Loader::Base
+      # Duration of waiting between API call
       WAIT_TIME = 1
 
+      # Initialize SlackScratcher::Loader::Api object.
+      #
+      # @see https://api.slack.com/web
+      #
+      # @param [String] token Slack API token. It also can be set by using
+      #   ENV['SLACK_TOKEN']
+      #
+      # @example Create File loader obect
+      #   token = '123456789'
+      #   SlackScratcher::Loader::Api.new token
+      #
+      # @return [SlackScratcher::Loader::Api] Api loader object
       def initialize(token = nil)
         authenticate_slack(token)
       end
 
+      # Iterate all log data which is parsed from Slack API.
+      #
+      # @param [SlackScratcher::Adapter::Base] adapter Datastore adapter
+      #   for getting when to starting fetch log
+      #
+      # @example Iterate all logs for priniting contents
+      #   loader.each { |data| puts data }
+      #
+      # return [Boolean] If there isn't any ploblem, it returns true
       def each(adapter)
         @users || set_users
 
@@ -24,11 +47,13 @@ module SlackScratcher
 
       private
 
+      # @private
       def set_users
         @users = users
         SlackScratcher.logger.info "* Users list refreshed"
       end
 
+      # @private
       def check_users(logs)
         logs
           .select { |log| log.key? 'user' }
@@ -36,6 +61,7 @@ module SlackScratcher
           .any? { |user| @users[user].nil? }
       end
 
+      # @private
       def parse_log(channel, from)
         logs = channel_history(channel[:id], from)
         if check_users(logs)
@@ -44,17 +70,20 @@ module SlackScratcher
         SlackScratcher::Model::Chats.new(logs, channel, @users).refined_data
       end
 
+      # @private
       def authenticate_slack(token)
         token ||= ENV['SLACK_TOKEN']
         fail SlackScratcher::Error::TokenNotSet unless token
         Slack.configure { |config| config.token = token }
       end
 
+      # @private
       def channels
         response = validate_response(Slack.channels_list)
         index_channels response['channels']
       end
 
+      # @private
       def active_channels
         wait
 
@@ -62,14 +91,17 @@ module SlackScratcher
         index_channels filter_active_channels(response['channels'])
       end
 
+      # @private
       def filter_active_channels(data)
         data.select { |channel| channel['is_archived'] == false }
       end
 
+      # @private
       def index_channels(data)
         data.map { |channel| { id: channel['id'], name: channel['name'] } }
       end
 
+      # @private
       def users
         wait
 
@@ -77,6 +109,7 @@ module SlackScratcher
         SlackScratcher::Helper.index_data user_list, 'id'
       end
 
+      # @private
       def channel_history(channel_id, from, to = Time.now)
         wait
 
@@ -90,12 +123,14 @@ module SlackScratcher
         validate_response Slack.channels_history(attrs), :messages
       end
 
+      # @private
       def validate_response(response, key = nil)
         fail SlackScratcher::Error::ApiError unless response['ok'] == true
         return response unless key
         response[key.to_s]
       end
 
+      # @private
       def wait
         sleep WAIT_TIME
       end

data/lib/slack_scratcher/loader/base.rb

@@ -0,0 +1,19 @@
+module SlackScratcher
+  module Loader
+    # Abstract loader class for importing slack log data
+    # @since 0.1
+    class Base
+      include Enumerable
+
+      # @ abstract
+      def initialize
+        fail NotImplementedError
+      end
+
+      # @ abstract
+      def each
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/slack_scratcher/loader/file.rb

@@ -2,9 +2,19 @@ require 'oj'
 
 module SlackScratcher
   module Loader
-    class File
-      include Enumerable
-
+    # Loader class for importing slack log data from exported data.
+    #
+    # @since 0.0.1
+    class File < SlackScratcher::Loader::Base
+      # Initialize SlackScratcher::Loader::File object.
+      #
+      # @param [String] target_dir Directory which unarchived log data
+      #
+      # @example Create File loader obect
+      #   target_dir = '~/tmp/my_slack-2015-03-16/'
+      #   SlackScratcher::Loader::File.new target_dir
+      #
+      # @return [SlackScratcher::Loader::File] File loader object
       def initialize(target_dir)
         fail ArgumentError unless ::File.directory?(target_dir)
 
@@ -13,6 +23,14 @@ module SlackScratcher
         @channels = channels
       end
 
+      # Iterate all log data which is parsed from log file in log directory
+      #
+      # @param [NilClass] _ Not use
+      #
+      # @example Iterate all logs for priniting contents
+      #   loader.each { |data| puts data }
+      #
+      # return [Boolean] If there isn't any ploblem, it returns true
       def each(_ = nil)
         files.each do |file|
           yield parse_log_file(file), file
@@ -23,18 +41,22 @@ module SlackScratcher
 
       private
 
+      # @private
       def get_channel_dir(path)
         ::File.dirname(path).split('/').last
       end
 
+      # @private
       def users
         load "#{@target}/users.json", 'id'
       end
 
+      # @private
       def channels
         load "#{@target}/channels.json", 'name'
       end
 
+      # @private
       def load(target, index_column)
         fail SlackScratcher::Error::FileNotFound unless ::File.exist? target
 
@@ -42,27 +64,32 @@ module SlackScratcher
         SlackScratcher::Helper.index_data channels, index_column
       end
 
+      # @private
       def channel_info(log_file)
         name = get_channel_dir(log_file)
         { name: name, id: @channels[name]['id'] }
       end
 
+      # @private
       def parse_log_file(log_file)
         channel = channel_info(log_file)
         logs = Oj.load(::File.read(log_file))
         SlackScratcher::Model::Chats.new(logs, channel, @users).refined_data
       end
 
+      # @private
       def files
         channel_dirs.inject([]) do |arr, channel|
           arr + log_files(channel)
         end
       end
 
+      # @private
       def channel_dirs
         Dir["#{@target}/*/"]
       end
 
+      # @private
       def log_files(channel)
         Dir["#{channel}*.json"]
       end

data/lib/slack_scratcher/model.rb

@@ -1,4 +1,6 @@
 module SlackScratcher
+  # SlackScratcher model namespace
+  # @since 0.0.1
   module Model
     autoload :Chats, 'slack_scratcher/model/chats'
   end

data/lib/slack_scratcher/model/chats.rb

@@ -1,8 +1,26 @@
 module SlackScratcher
   module Model
+    # Chats model for processing chat data
+    #
+    # @since 0.0.1
+    # @attr_reader [Array] data Original data
+    # @attr_reader [Array] refined_data data which is processed
     class Chats
-      attr_reader :refined_data, :data
-
+      attr_reader :data, :refined_data
+
+      # Initialize SlackScratcher::Model::Chats object. This class is
+      # used in Loaders
+      #
+      # @see SlackScratcher::Loader::File
+      # @see SlackScratcher::Loader::Api
+      #
+      # @param [Array] Data chatting data from loader
+      # @param [Hash] channel Hash which have Channel informaiton
+      # @option channel [string] :id Channel's unique id
+      # @option channel [string] :name Channel's name
+      # @param [Hash] users Information of all user
+      #
+      # @return [SlackScratcher::Model::Chats] Chats model object
       def initialize(data, channel, users)
         if !data.is_a?(Array) || !users.is_a?(Hash) || !channel.is_a?(Hash)
           fail ArgumentError
@@ -17,12 +35,14 @@ module SlackScratcher
 
       private
 
+      # @private
       def refine
         @data
           .map { |log| refine_data(log) }
           .select { |log| !log['uid'].nil? }
       end
 
+      # @private
       def refine_data(log)
         user = find_user(log) unless user
 
@@ -38,10 +58,12 @@ module SlackScratcher
         log
       end
 
+      # @private
       def create_uid(log)
         "#{log['datetime']}-#{log['channel_id']}-#{log['username']}"
       end
 
+      # @private
       def refine_text(text)
         text = ":#{text}" if text.is_a?(Symbol)
 
@@ -50,6 +72,7 @@ module SlackScratcher
           .gsub(%r{<(http(s)?://.*?)>}) { $1 }
       end
 
+      # @private
       def find_user(log)
         return bot_user(log) if log.key?('username')
 
@@ -61,12 +84,14 @@ module SlackScratcher
         unknown_user
       end
 
+      # @private
       def undefined_user
         user = { 'name' => '_unknown_' }
         user['profile'] = { 'image_32' => '' }
         user
       end
 
+      # @private
       def bot_user(log)
         user = { 'name' => log['username'] }
         user['profile'] = { 'image_32' => log['icons']['image_48'] }

data/lib/slack_scratcher/router.rb

@@ -1,26 +1,51 @@
 module SlackScratcher
+  # Slack log router. This import log data from loader, and route them
+  # to adapter
+  #
+  # @since 0.0.1
   class Router
+    # Initalize SlackScratcher::Router object
+    #
+    # @param [SlackScratcher::Loader::Base] loader
+    # @param [SlackScratcher::Adapter::Base] adapter
+    #
+    # @example Initialize router object
+    #   SlackScratcher::Router.new(loader, adapter)
+    #
+    # @return [SlackScratcher::Router] Router object
     def initialize(loader, adapter)
       @loader = loader
       @adapter = adapter
     end
 
+    # Route logs to adapter
+    #
+    # @return [Boolean] There isn't any problem, it returns true
     def route
       ready
       _route
+      true
     end
 
+    # Run loop to route logs in real time
+    #
+    # @return [Boolean] If loop interrupted, it return false
     def route_loop
       ready
       loop { _route }
+    rescue Interrupt => error
+      SlackScratcher.logger.info error
+      false
     end
 
     private
 
+    # @private
     def ready
       @adapter.ready_index
     end
 
+    # @private
     def _route
       @loader.each(@adapter) do |data, metadata|
         if data.empty?

data/lib/slack_scratcher/version.rb

@@ -1,3 +1,4 @@
 module SlackScratcher
-  VERSION = '0.1'
+  # Current version of SlackScratcher
+  VERSION = '0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack_scratcher
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Daekwon Kim
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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: guard
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +179,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: inch
+  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: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -174,6 +216,7 @@ extra_rdoc_files: []
 files:
 - lib/slack_scratcher.rb
 - lib/slack_scratcher/adapter.rb
+- lib/slack_scratcher/adapter/base.rb
 - lib/slack_scratcher/adapter/elasticsearch.rb
 - lib/slack_scratcher/adapter/file.rb
 - lib/slack_scratcher/error.rb
@@ -184,6 +227,7 @@ files:
 - lib/slack_scratcher/helper.rb
 - lib/slack_scratcher/loader.rb
 - lib/slack_scratcher/loader/api.rb
+- lib/slack_scratcher/loader/base.rb
 - lib/slack_scratcher/loader/file.rb
 - lib/slack_scratcher/model.rb
 - lib/slack_scratcher/model/chats.rb