akane 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de30517cd16b9dd52bf5628602e20e22dfcb594a
-  data.tar.gz: 509875d93f4c1bcebfb950f289b206d69916f2ea
+  metadata.gz: 8bc71995c8cc299ddc5b873403f69f427ab87f6d
+  data.tar.gz: cdffc166e5a090a3159c60e3e2507b51d4eac98c
 SHA512:
-  metadata.gz: 98ec5786e6587eac236b868309b85fc9a8d1fc445b761f927e1085c04629fb7534105bee28bec99796af86b7aa2ba44ea9e87fb5f6a738370b5ca97e36a91038
-  data.tar.gz: 3c6ab75d276a089ce1a0486dfb608c3a09f029ece9096a94a98caf2927447ef275c9f64338e7f707ae96dd273da997b18e0d1b9cea35935e4d8e59c6720c4d2a
+  metadata.gz: 74c163daa0604773c155a7828f9417605ba200e9f041a91d879855cb3c5784a0bff53c25cbca4f10b7a39fa3c5334f39fdf8f463dc46f9c21484ca1d5dab763e
+  data.tar.gz: c75dde351210dfbec90073c72aa1c7c75320538e398d0c4232729b811936c2b9e89e074d594e8522fdcd278f6c39f2ae90419fa0303aaaaa7fd70a01119c5840

data/README.md

@@ -10,9 +10,15 @@ Log your timeline
 
     $ gem install akane
 
-## Usage
+## Set up
 
-TBD
+See `akane.example.yml`
+
+## Start
+
+```
+$ akane start -c /path/to/akane.yml
+```
 
 ## Todo
 

data/akane.example.yml

@@ -2,13 +2,24 @@
 consumer:
   token: CONSUMER_TOKEN
   secret: CONSUMER_SECRET
+
+# You can issue access tokens for accounts by using `akane auth` command.
 accounts:
   your_account_name1:
     token: ACCESS_TOKEN1
     secret: SECRET_TOKEN1
+# You can specify custom receivers for each account.
+# by default, `receivers: ["stream"]` will be used.
+#    receivers:
+#      - stream
+#      - stream:
+#          method: filter
+#          options:
+#            track: foo,bar,baz
   your_account_name2:
     token: ACCESS_TOKEN2
     secret: SECRET_TOKEN2
+
 storages:
   - stdout
   - file:

data/lib/akane/manager.rb

@@ -1,6 +1,7 @@
 require 'akane/config'
 require 'akane/recorder'
-require 'akane/receivers/stream'
+require 'akane/receivers'
+require 'akane/storages'
 
 module Akane
   class Manager
@@ -11,43 +12,10 @@ module Akane
 
     def prepare
       @logger.info 'Preparing'
-      @receivers = @config["accounts"].map do |name, credential|
-        Akane::Receivers::Stream.new(
-          consumer: {token: @config["consumer"]["token"], secret: @config["consumer"]["secret"]},
-          account: {token: credential["token"], secret: credential["secret"]},
-          logger: @config.logger
-        ).tap do |receiver|
-          @logger.info "Preparing... receiver - #{receiver.class}"
-          receiver.on_tweet(  &(method(:on_tweet).to_proc.curry[name]))
-          receiver.on_message(&(method(:on_message).to_proc.curry[name]))
-          receiver.on_event(  &(method(:on_event).to_proc.curry[name]))
-          receiver.on_delete( &(method(:on_delete).to_proc.curry[name]))
-        end
-      end
 
-      @storages = @config["storages"].flat_map do |definition|
-        case definition
-        when Hash
-          definition.map do |kind, config|
-            [kind, config]
-          end
-        when String
-          [[definition, {}]]
-        end
-      end.map do |kind, config|
-        @logger.info "Preparing... storage - #{kind}"
-        require "akane/storages/#{kind}"
-        Akane::Storages.const_get(kind.gsub(/(?:\A|_)(.)/) { $1.upcase }).new(
-          config: config,
-          logger: @config.logger
-        )
-      end
-
-      @recorder = Akane::Recorder.new(
-        @storages,
-        timeout: @config["timeout"] || 20,
-        logger: @config.logger
-      )
+      prepare_receivers
+      prepare_storages
+      prepare_recorder
 
       @logger.info "Prepared with #{@storages.size} storage(s) and #{@receivers.size} receiver(s)"
     end
@@ -129,5 +97,63 @@ module Akane
     def on_delete(account, user_id, tweet_id)
       @recorder.mark_as_deleted(account, user_id, tweet_id)
     end
+
+    def prepare_receivers
+      @receivers = @config["accounts"].flat_map do |name, credential|
+        receiver_definitions = credential["receivers"] || ['stream']
+
+        receiver_definitions.map do |definition|
+          if definition.kind_of?(Hash)
+            if 1 < definition.size
+              @logger.warn "Only 1 receiver definition is used in one Hash instance."
+            end
+
+            kind, config = definition.each.first
+          else
+            kind, config = definition, {}
+          end
+
+          Akane::Receivers.find(kind).new(
+            consumer: {token: @config["consumer"]["token"], secret: @config["consumer"]["secret"]},
+            account: {token: credential["token"], secret: credential["secret"], name: name},
+            config: config,
+            logger: @config.logger
+          ).tap do |receiver|
+            @logger.info "Preparing... receiver - #{receiver.class}"
+            receiver.on_tweet(&(  method(:on_tweet).to_proc.curry[receiver.name]))
+            receiver.on_message(&(method(:on_message).to_proc.curry[receiver.name]))
+            receiver.on_event(&(  method(:on_event).to_proc.curry[receiver.name]))
+            receiver.on_delete(&( method(:on_delete).to_proc.curry[receiver.name]))
+          end
+        end
+      end
+    end
+
+    def prepare_storages
+      @storages = @config["storages"].flat_map do |definition|
+        case definition
+        when Hash
+          definition.map do |kind, config|
+            [kind, config]
+          end
+        when String
+          [[definition, {}]]
+        end
+      end.map do |kind, config|
+        @logger.info "Preparing... storage - #{kind}"
+        Akane::Storages.find(kind).new(
+          config: config,
+          logger: @config.logger
+        )
+      end
+    end
+
+    def prepare_recorder
+      @recorder = Akane::Recorder.new(
+        @storages,
+        timeout: @config["timeout"] || 20,
+        logger: @config.logger
+      )
+    end
   end
 end

data/lib/akane/receivers.rb

@@ -0,0 +1,17 @@
+module Akane
+  module Receivers
+    def self.find(name)
+      class_name = name.gsub(/(?:\A|_)(.)/) { $1.upcase }
+
+      retried = false
+      begin
+        return Akane::Receivers.const_get(class_name, false)
+      rescue NameError => e
+        raise e if retried
+        retried = true
+        require "akane/receivers/#{name}"
+        retry
+      end
+    end
+  end
+end

data/lib/akane/receivers/abstract_receiver.rb

@@ -4,6 +4,7 @@ module Akane
       def initialize(consumer: raise(ArgumentError, 'missing consumer'),
                      account:  raise(ArgumentError, 'missing account'),
                      logger: Logger.new($stdout),
+                     name: nil,
                      config: {})
         @consumer = consumer
         @account = account
@@ -13,6 +14,10 @@ module Akane
         @hooks = {}
       end
 
+      def name
+        @name ||= @config['name'] || "#{cname}:#{@account[:name]}"
+      end
+
       def start
         raise NotImplementedError
       end
@@ -37,6 +42,10 @@ module Akane
 
       private
 
+      def cname
+        @cname = self.class.name.split(/::/).last
+      end
+
       def invoke(kind, *args)
         return unless @hooks[kind]
         @hooks[kind].each { |hook| hook.call(*args) }

data/lib/akane/receivers/stream.rb

@@ -7,6 +7,26 @@ module Akane
       def initialize(*)
         super
         @thread = nil
+
+        if @config["method"]
+          @stream_method = @config["method"].to_sym
+        else
+          @stream_method = :user
+        end
+
+        if @config["options"]
+          @stream_options = Hash[@config["options"].map do |k,v|
+            [k.to_sym, v]
+          end]
+        else
+          @stream_options = {}
+        end
+      end
+
+      def name
+        # For backward compatibility, user stream returns only account name if
+        # config.name not specified.
+        @name ||= @config['name'] || @account[:name]
       end
 
       def running?() !!(@thread && @thread.alive?) end
@@ -27,7 +47,7 @@ module Akane
 
         @thread = Thread.new do
           begin
-            stream.user do |obj|
+            stream.send(@stream_method, @stream_options) do |obj|
               case obj
               when Twitter::Tweet
                 invoke(:tweet, obj)

data/lib/akane/storages.rb

@@ -0,0 +1,17 @@
+module Akane
+  module Storages
+    def self.find(name)
+      class_name = name.gsub(/(?:\A|_)(.)/) { $1.upcase }
+
+      retried = false
+      begin
+        return Akane::Storages.const_get(class_name, false)
+      rescue NameError => e
+        raise e if retried
+        retried = true
+        require "akane/storages/#{name}"
+        retry
+      end
+    end
+  end
+end

data/lib/akane/version.rb

@@ -1,3 +1,3 @@
 module Akane
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/manager_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 require 'akane/manager'
 require 'akane/receivers/stream'
+require 'akane/receivers/abstract_receiver'
 require 'akane/storages/mock'
 require 'akane/config'
 
@@ -35,7 +36,8 @@ describe Akane::Manager do
     it "creates receivers" do
       Akane::Receivers::Stream.should_receive(:new) \
         .with(consumer: {token: 'consumer-token', secret: 'consumer-secret'},
-              account:  {token: 'a-access-token', secret: 'a-access-secret'},
+              account:  {token: 'a-access-token', secret: 'a-access-secret', name: 'a'},
+              config: {},
               logger: config.logger) \
         .and_return(double("a").as_null_object)
 
@@ -54,6 +56,58 @@ describe Akane::Manager do
 
       subject.prepare
     end
+
+    context "with config.accounts[].receivers" do
+      let(:conf_accounts) do
+        {
+          "a" => {
+            "token" => "a-access-token",
+            "secret" => "a-access-secret",
+            "receivers" => [
+              'foo',
+              {"bar" => {'hello' => 'hola',}},
+            ],
+          },
+          "b" => {
+            "token" => "b-access-token",
+            "secret" => "b-access-secret",
+          },
+        }
+      end
+
+      let(:foo_receiver) { Class.new(Akane::Receivers::AbstractReceiver) {} }
+      let(:bar_receiver) { Class.new(Akane::Receivers::AbstractReceiver) {} }
+
+      before do
+        stub_const 'Akane::Receivers::Foo', foo_receiver
+        stub_const 'Akane::Receivers::Bar', bar_receiver
+      end
+
+      it "creates receivers" do
+        expect(foo_receiver).to receive(:new) \
+          .with(consumer: {token: 'consumer-token', secret: 'consumer-secret'},
+                account:  {token: 'a-access-token', secret: 'a-access-secret', name: 'a'},
+                config: {},
+                logger: config.logger) \
+          .and_return(double("foo").as_null_object)
+
+        expect(bar_receiver).to receive(:new) \
+          .with(consumer: {token: 'consumer-token', secret: 'consumer-secret'},
+                account:  {token: 'a-access-token', secret: 'a-access-secret', name: 'a'},
+                config: {'hello' => 'hola',},
+                logger: config.logger) \
+          .and_return(double("bar").as_null_object)
+
+        Akane::Receivers::Stream.should_receive(:new) \
+          .with(consumer: {token: 'consumer-token', secret: 'consumer-secret'},
+                account:  {token: 'b-access-token', secret: 'b-access-secret', name: 'b'},
+                config: {},
+                logger: config.logger) \
+          .and_return(double("bstream").as_null_object)
+
+        subject.prepare
+      end
+    end
   end
 
   describe "#start" do
@@ -64,6 +118,7 @@ describe Akane::Manager do
       Akane::Recorder.stub(new: recorder)
 
       @on_event, @on_tweet, @on_delete, @on_message = nil
+      receiver.stub(name: 'a')
       receiver.stub(:on_event)   { |&block| @on_event   = block }
       receiver.stub(:on_tweet)   { |&block| @on_tweet   = block }
       receiver.stub(:on_delete)  { |&block| @on_delete  = block }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akane
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Shota Fukumori (sora_h)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-06 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -143,9 +143,11 @@ files:
 - lib/akane/cli.rb
 - lib/akane/config.rb
 - lib/akane/manager.rb
+- lib/akane/receivers.rb
 - lib/akane/receivers/abstract_receiver.rb
 - lib/akane/receivers/stream.rb
 - lib/akane/recorder.rb
+- lib/akane/storages.rb
 - lib/akane/storages/abstract_storage.rb
 - lib/akane/storages/elasticsearch.rb
 - lib/akane/storages/file.rb