speedflow-plugin-flowdock 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 548e8eba2e01faa888d48cd50f1257572f232b03
-  data.tar.gz: 2c3aec53775f4c77e3f784671637c7a3fd417551
+  metadata.gz: edecbbf442d178fe48d334e12d510ff87ec1a809
+  data.tar.gz: 1d0050478441ba631fce827003dc5db5b24c3b80
 SHA512:
-  metadata.gz: 337ef2a56bb0ea50aa2780d318726ac276e14c696c5d22e1b0cb64a27250b96076ba327dc910641d167ec8b7adff58534cacb3e7007a5c2e7134dad3042bc1fd
-  data.tar.gz: b01efd1fc443855263cc555db505bf3a4b12df89747d2ee541a7ab29a26c0f385ef0761c43f84e2d665fe41bc99b4e7b33aebbc677071d7d7ab12de216d6e977
+  metadata.gz: fa39046538e336e12d2422e2cde9a33e4ca4f59082d232df1c5d6a6d01bf1880bc3287034615775fce8a615a908aab6afb0541ea1af47f0fe5547656c2e66b23
+  data.tar.gz: 72dbe45465b420c08d47442115026c0382ea22f33146a716ffe0f3a4686f4daf80ebba0ae5b0f57bf4c0357902c3afed75f7e6b73904eb138e61ceb6ee762069

data/lib/speedflow/plugin/flowdock.rb

@@ -1,43 +1,5 @@
+require 'speedflow'
+
 require 'speedflow/plugin/flowdock/version'
-require 'speedflow/plugin/flowdock/plugin_core'
-require 'speedflow/plugin/flowdock/prompt'
-require 'speedflow/plugin/flowdock/configuration'
+require 'speedflow/plugin/flowdock/plugin'
 require 'speedflow/plugin/flowdock/client'
-
-# Speedflow GEM, help you to boost your flow and keep your time.
-module Speedflow
-  module Plugin
-    # Flowdock Speedflow plugin.
-    module Flowdock
-      # TODO: Move this system in the core Utils
-      class << self
-        ACTIONS = [
-          :action_notify
-        ].freeze
-
-        # @return [Speedflow::Plugin::Flowdock.PluginCore] Plugin.
-        attr_writer :plugin
-
-        # Public: Magic method to route to action
-        #
-        # args - Some arguments :)
-        #
-        # Returns nothing.
-        def method_missing(*args)
-          action = args.first
-
-          raise NoMethodError, action unless ACTIONS.include? action
-
-          plugin.new(args.last).send(action)
-        end
-
-        # Public: Plugin.
-        #
-        # Returns Speedflow::Plugin::Flowdock.PluginCore instance.
-        def plugin
-          @plugin ||= PluginCore
-        end
-      end
-    end
-  end
-end

data/lib/speedflow/plugin/flowdock/client.rb

@@ -5,20 +5,23 @@ module Speedflow
     module Flowdock
       # Flowdock client
       class Client
-        # @return [Prompt] Prompt.
-        attr_writer :prompt
+        # @return [Speedflow::Plugin::Configuration] Plugin configuration.
+        attr_reader :config
+
+        # @return [Speedflow::Plugin::Prompt] Plugin prompt.
+        attr_reader :prompt
 
         # @return [Flowdock::Client] Flowdock client.
         attr_writer :flowdock_client
 
         # Initialize.
         #
-        # config - Speedflow::Plugin::Flowdock::Configuration instance.
-        # prompt - Speedflow::Plugin::Flowdock::Prompt instance.
+        # config - <Speedflow::Plugin::Configuration> instance.
+        # prompt - <Speedflow::Plugin::Prompt> instance.
         #
         # Examples
         #
-        #    Client.new({}, Speedflow::Plugin::Flowdock::Prompt.new)
+        #    Client.new({}, Speedflow::Plugin::Prompt.new)
         #    # => <Speedflow::Plugin::Flowdock::Client>
         #
         # Returns nothing.
@@ -48,22 +51,16 @@ module Speedflow
         def safe
           yield
         rescue ::Flowdock::ApiError => exception
-          prompt.errors exception
+          prompt.errors 'Flowdock', exception
           abort
         end
 
         # Public: Flowdock client.
         #
-        # Returns ::Flowdock::Client instance.
+        # Returns <::Flowdock::Client> instance.
         def flowdock_client
-          @flowdock_client ||= ::Flowdock::Client.new(@config.auth)
-        end
-
-        # Public: Prompt.
-        #
-        # Returns ::Speedflow::Plugin::Flowdock::Prompt instance.
-        def prompt
-          @prompt ||= ::Speedflow::Plugin::Flowdock::Prompt.new
+          config = { api_token: @config.by_config('token') }
+          @flowdock_client ||= ::Flowdock::Client.new(config)
         end
       end
     end

data/lib/speedflow/plugin/flowdock/plugin.rb

@@ -0,0 +1,36 @@
+module Speedflow
+  module Plugin
+    module Flowdock
+      # Plugin core
+      class Plugin < Speedflow::Plugin::Abstract
+        # @return [<Speedflow::Flowdock::Client>] Plugin client.
+        attr_writer :client
+
+        # Public: Notify.
+        #
+        # Returns Hash of result.
+        def action_notify
+          flow_id_or_token = config.by_input('flow', config.by_config('flow'))
+
+          message = config.by_input('message')
+          tags    = config.by_input('tags').split(',')
+
+          client.notify(flow_id_or_token, message, tags)
+
+          prompt.ok '[FLOWDOCK] Flow was notified'
+
+          # ACTION: action_notify
+          # OUTPUT: { 'message' => String, 'tags' => [] }
+          { 'message' => message, 'tags' => tags }
+        end
+
+        # Public: Plugin client.
+        #
+        # Returns <Speedflow::Flowdock::Client> instance.
+        def client
+          @client ||= Client.new(@config, @prompt)
+        end
+      end
+    end
+  end
+end

data/lib/speedflow/plugin/flowdock/version.rb

@@ -1,7 +1,7 @@
 module Speedflow
   module Plugin
     module Flowdock
-      VERSION = '0.2.1'.freeze
+      VERSION = '0.3.0'.freeze
     end
   end
 end

data/spec/speedflow/plugin/flowdock/client_spec.rb

@@ -2,13 +2,18 @@ require 'spec_helper'
 
 describe Speedflow::Plugin::Flowdock::Client do
   let(:client) do
-    client = ::Speedflow::Plugin::Flowdock::Client.new(double, double)
+    client = Speedflow::Plugin::Flowdock::Client.new(double, double)
     client.flowdock_client = double
     client
   end
 
   it '.notify' do
-    allow(client.flowdock_client).to receive(:chat_message)
+    allow(client.config)
+      .to receive(:by_config)
+      .with('token')
+      .and_return('XXX')
+    allow(client.flowdock_client)
+      .to receive(:chat_message)
 
     client.notify('XXX', 'Hello', %w(foo bar baz))
   end

data/spec/speedflow/plugin/flowdock/{plugin_core_spec.rb → plugin_spec.rb}

@@ -1,15 +1,13 @@
 require 'spec_helper'
 
-describe Speedflow::Plugin::Flowdock::PluginCore do
+describe Speedflow::Plugin::Flowdock::Plugin do
   let(:plugin) do
-    plugin = ::Speedflow::Plugin::Flowdock::PluginCore.new({})
-    plugin.config = double
-    plugin.prompt = double
+    plugin = ::Speedflow::Plugin::Flowdock::Plugin.new(double, double)
     plugin.client = double
     plugin
   end
 
-  it '.action_create_issue' do
+  it '.action_notify' do
     allow(plugin.config)
       .to receive(:by_config)
       .with('flow')
@@ -26,7 +24,7 @@ describe Speedflow::Plugin::Flowdock::PluginCore do
       .to receive(:by_input)
       .with('tags')
       .and_return('foo,bar,baz')
-    
+
     allow(plugin.prompt)
       .to receive(:ok)
       .with('[FLOWDOCK] Flow was notified')
@@ -35,6 +33,8 @@ describe Speedflow::Plugin::Flowdock::PluginCore do
       .to receive(:notify)
       .with('XXX', 'Hello', %w(foo bar baz))
 
-    plugin.action_notify
+    expected_hash = { 'message' => 'Hello', 'tags' => %w(foo bar baz) }
+    expect(plugin.action_notify)
+      .to eq expected_hash
   end
 end

data/spec/speedflow/plugin/flowdock_spec.rb

@@ -1,20 +1,7 @@
 require 'spec_helper'
 
 describe Speedflow::Plugin::Flowdock do
-  let(:plugin) do
-    double(new: double(action_notify: nil))
-  end
-
   it 'has a version number' do
     expect(Speedflow::Plugin::Flowdock::VERSION).not_to be nil
   end
-
-  it 'has an action catcher' do
-    expect { Speedflow::Plugin::Flowdock.action_lol }
-      .to raise_error(NoMethodError)
-
-    Speedflow::Plugin::Flowdock.plugin = plugin
-
-    expect(Speedflow::Plugin::Flowdock.action_notify).to eq nil
-  end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: speedflow-plugin-flowdock
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Julien Breux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: flowdock
+  name: speedflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: flowdock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,15 +178,11 @@ files:
 - lib/speedflow-plugin-flowdock.rb
 - lib/speedflow/plugin/flowdock.rb
 - lib/speedflow/plugin/flowdock/client.rb
-- lib/speedflow/plugin/flowdock/configuration.rb
-- lib/speedflow/plugin/flowdock/plugin_core.rb
-- lib/speedflow/plugin/flowdock/prompt.rb
+- lib/speedflow/plugin/flowdock/plugin.rb
 - lib/speedflow/plugin/flowdock/version.rb
 - spec/spec_helper.rb
 - spec/speedflow/plugin/flowdock/client_spec.rb
-- spec/speedflow/plugin/flowdock/configuration_spec.rb
-- spec/speedflow/plugin/flowdock/plugin_core_spec.rb
-- spec/speedflow/plugin/flowdock/prompt_spec.rb
+- spec/speedflow/plugin/flowdock/plugin_spec.rb
 - spec/speedflow/plugin/flowdock_spec.rb
 homepage: https://github.com/speedflow/speedflow-plugin-flowdock
 licenses:

data/lib/speedflow/plugin/flowdock/configuration.rb

@@ -1,79 +0,0 @@
-module Speedflow
-  module Plugin
-    module Flowdock
-      # Flowdock Configuration
-      class Configuration
-        CONFIG_KEY = '_config'.freeze
-        PLUGIN_KEY = 'flowdock'.freeze
-
-        # Initialize.
-        #
-        # arguments - Hash of arguments.
-        #
-        # Examples
-        #
-        #    Configuration.new({})
-        #    # => <Speedflow::Plugin::Flowdock::Configuration>
-        #
-        # Returns nothing.
-        def initialize(arguments)
-          @arguments = arguments
-        end
-
-        # Public: Auth configuration.
-        #
-        # Returns Hash of auth configuration.
-        def auth
-          {
-            api_token: by_config('token')
-          }
-        end
-
-        # Public: Get a specific config.
-        #
-        # key           - Key of config.
-        # default_value - Default value.
-        #
-        # Returns value of config key.
-        def by_config(key, default_value = '')
-          if @arguments.key?(CONFIG_KEY) &&
-             @arguments[CONFIG_KEY].key?(PLUGIN_KEY)
-            config = @arguments[CONFIG_KEY][PLUGIN_KEY]
-          end
-          config.key?(key) ? config[key] : default_value
-        end
-
-        # Public: Get an input config by key.
-        #
-        # key           - Key of config.
-        # default_value - Default value.
-        #
-        # Returns value of input config key.
-        def by_input(key, default_value = '')
-          if @arguments.key?(key)
-            @arguments[key]['value']
-          else
-            default_value
-          end
-        end
-
-        # Public: Get an input config by key but required.
-        #
-        # key           - Key of config.
-        # default_value - Default value.
-        #
-        # Returns value of input config key or Exception.
-        def by_required_input(key, default_value = '')
-          value = by_input(key, default_value)
-
-          # TODO: Improve communication with core for errors
-          if by_input(key).empty?
-            raise Exception, "Required value for '#{key}'."
-          end
-
-          value
-        end
-      end
-    end
-  end
-end

data/lib/speedflow/plugin/flowdock/plugin_core.rb

@@ -1,66 +0,0 @@
-module Speedflow
-  module Plugin
-    module Flowdock
-      # Plugin core
-      class PluginCore
-        # @return [Prompt] Plugin prompt.
-        attr_writer :prompt
-
-        # @return [Client] Plugin client.
-        attr_writer :client
-
-        # @return [Config] Plugin config.
-        attr_writer :config
-
-        # Initialize.
-        #
-        # arguments - Hash of arguments.
-        #
-        # Examples
-        #
-        #    Plugin.new({})
-        #    # => <Speedflow::Plugin::Flowdock::PluginCore>
-        #
-        # Returns nothing.
-        def initialize(arguments)
-          @arguments = arguments
-        end
-
-        # Public: Notify.
-        #
-        # Returns nothing.
-        def action_notify
-          flow_id_or_token = config.by_input('flow', config.by_config('flow'))
-
-          message = config.by_input('message')
-          tags    = config.by_input('tags').split(',')
-
-          client.notify(flow_id_or_token, message, tags)
-
-          prompt.ok '[FLOWDOCK] Flow was notified'
-        end
-
-        # Public: Plugin configuration.
-        #
-        # Returns Configuration instance.
-        def config
-          @config ||= Configuration.new(@arguments)
-        end
-
-        # Public: Plugin client.
-        #
-        # Returns Client instance.
-        def client
-          @client ||= Client.new(@config, @prompt)
-        end
-
-        # Public: Plugin prompt.
-        #
-        # Returns Prompt instance.
-        def prompt
-          @prompt ||= Prompt.new
-        end
-      end
-    end
-  end
-end

data/lib/speedflow/plugin/flowdock/prompt.rb

@@ -1,42 +0,0 @@
-require 'tty-prompt'
-require 'json'
-
-module Speedflow
-  module Plugin
-    module Flowdock
-      # Plugin prompt
-      class Prompt # < TTY::Prompt
-        # @return [TTY::Prompt] TTY::Prompt.
-        attr_writer :prompt
-
-        # Public: Errors from Flowdock exception.
-        #
-        # exception - Flowdock::ApiError.
-        #
-        # Returns nothing.
-        def errors(exception)
-          prompt.error 'Flowdock errors'
-          prompt.warn exception.message
-        end
-
-        # Delegate.
-        #
-        # method - Method.
-        # args   - Arguments.
-        # block  - Block.
-        #
-        # Returns wathever.
-        def method_missing(method, *args, &block)
-          prompt.send(method, *args, &block)
-        end
-
-        # Public: TTY prompt.
-        #
-        # Returns ::TTY::Prompt instance.
-        def prompt
-          @prompt ||= ::TTY::Prompt.new
-        end
-      end
-    end
-  end
-end

data/spec/speedflow/plugin/flowdock/configuration_spec.rb

@@ -1,48 +0,0 @@
-require 'spec_helper'
-
-describe Speedflow::Plugin::Flowdock::Configuration do
-  let(:config) do
-    message     = { 'value' => 'hello' }
-    tags        = { 'value' => 'foo,bar,baz' }
-    fd_config   = { 'token' => 'foo', 'flow' => 'bar' }
-    config      = { 'flowdock' => fd_config }
-    args        = { 'tags' => tags, 'message' => message, '_config' => config }
-    Speedflow::Plugin::Flowdock::Configuration.new(args)
-  end
-
-  it '.by_config' do
-    expect(config.by_config('token', 'default'))
-      .to eq 'foo'
-  end
-
-  it '.by_input' do
-    expect(config.by_input('message', 'default'))
-      .to eq 'hello'
-
-    expect(config.by_input('tags'))
-      .to eq 'foo,bar,baz'
-
-    expect(config.by_input('nomessage', 'default'))
-      .to eq 'default'
-  end
-
-  it '.by_required_input' do
-    expect(config.by_required_input('message', 'default'))
-      .to eq 'hello'
-
-    expect { config.by_required_input('nomessage') }
-      .to raise_error(Exception)
-
-    expect { config.by_required_input('nonomessage', 'default') }
-      .to raise_error(Exception)
-  end
-
-  it '.auth' do
-    returned_hash = {
-      api_token:    'foo'
-    }
-
-    expect(config.auth)
-      .to eq returned_hash
-  end
-end

data/spec/speedflow/plugin/flowdock/prompt_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-describe Speedflow::Plugin::Flowdock::Prompt do
-  let(:prompt) do
-    prompt = ::Speedflow::Plugin::Flowdock::Prompt.new
-    prompt.prompt = double
-    prompt
-  end
-  let(:exception) do
-    double(message: "Error\n")
-  end
-
-  it '.ok' do
-    allow(prompt.prompt)
-      .to receive(:ok).with('Test')
-
-    expect(prompt.ok('Test'))
-  end
-
-  it '.errors' do
-    allow(prompt.prompt)
-      .to receive(:error).with('Flowdock errors')
-    allow(prompt.prompt)
-      .to receive(:warn).with("Error\n")
-
-    expect(prompt.errors(exception))
-  end
-end