akane-imkayac 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd49543bd49ef4ab2bba3396875e3b90679356fb
+  data.tar.gz: f36a64cee9c99f744be4c42d557aa5131a7bded2
+SHA512:
+  metadata.gz: aeb16720d67c435eea156ad39471e40b8fde3973fa51e679c9b34f6218a3e41bbe6f7ebfcae00499b4ccc488ec97335f786a1276dac34076c66f12fccbfa9e4c
+  data.tar.gz: 31283f3d3b904b431f322eb8ceba7558a558ef3a0a867d2b8735a9fa7ce71aca40bcf83337ea5162432f74974375f7ad30e0daa8f9545df2288c6e7281124357

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shota Fukumori (sora_h)
+
+MIT License
+
+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,29 @@
+# Akane::Imkayac
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'akane-imkayac'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install akane-imkayac
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/akane-imkayac/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/akane-imkayac.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'akane-imkayac/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "akane-imkayac"
+  spec.version       = AkaneImkayac::VERSION
+  spec.authors       = ["Shota Fukumori (sora_h)"]
+  spec.email         = ["her@sorah.jp"]
+  spec.summary       = %q{imkayac storage plugin for akane | for notification}
+  spec.description   = %q{storage plugin for akane | sends matched tweets to im.kayac}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "akane", ">= 0.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "webmock", "~> 1.17.3"
+  spec.add_development_dependency "rake"
+end

data/lib/akane-imkayac.rb

@@ -0,0 +1,2 @@
+require 'akane-imkayac/version'
+require 'akane/storages/imkayac'

data/lib/akane-imkayac/version.rb

@@ -0,0 +1,3 @@
+module AkaneImkayac
+  VERSION = "0.0.1"
+end

data/lib/akane/imkayac.rb

@@ -0,0 +1,7 @@
+require "akane/imkayac/version"
+
+module Akane
+  module Imkayac
+    # Your code goes here...
+  end
+end

data/lib/akane/storages/imkayac.rb

@@ -0,0 +1,82 @@
+require 'net/http'
+require 'erb'
+require 'digest/sha1'
+require 'logger'
+require 'json'
+
+require 'akane/storages/abstract_storage'
+require 'akane-imkayac/version'
+
+module Akane
+  module Storages
+    class Imkayac < AbstractStorage
+      class RequestError < StandardError; end
+
+      VERSION = AkaneImkayac::VERSION
+      DEFAULT_ENDPOINT = 'http://im.kayac.com/api/post'.freeze
+      DEFAULT_MESSAGE = '[tw] <%= tweet.user.screen_name %>: <%= tweet.text %>'
+
+      def initialize(config: raise(ArgumentError, 'missing config'), logger: Logger.new($stdout))
+        super
+
+        @config["keywords"] ||= []
+        @config["excludes"] ||= []
+        @config["message"]  ||= DEFAULT_MESSAGE
+        @config["endpoint"] ||= DEFAULT_ENDPOINT
+
+
+        unless @config["user"]
+          raise ArgumentError, "config `user` is required"
+        end
+        unless @config["keywords"].kind_of?(Enumerable)
+          raise ArgumentError, "config `keywords` should be Enumerable"
+        end
+        unless @config["excludes"].kind_of?(Enumerable)
+          raise ArgumentError, "config `excludes` should be Enumerable"
+        end
+
+        @endpoint = URI.parse("#{@config["endpoint"].gsub(%r{/\z}, '')}/#{@config["user"]}")
+      end
+
+      def record_tweet(account, tweet)
+        unless tweet.text &&
+          !tweet.retweet? &&
+          @config["excludes"].all? { |_| ! tweet.text.include?(_.to_s) } &&
+          @config["keywords"].all? { |_| tweet.text.include?(_.to_s) }
+          return
+        end
+        payload = { message: ERB.new(@config["message"]).result(binding), }
+
+        payload[:password] = @config["password"] if @config["password"]
+
+        if @config["secret"]
+          payload[:sig] = Digest::SHA1.hexdigest("#{payload[:message]}#{@config["secret"]}")
+        end
+
+        if @config["handler"]
+          payload[:handler] = ERB.new(@config["handler"]).result(binding)
+        end
+
+        @logger.debug("im.kayac: sending #{payload[:message].inspect} to #{@config["user"].inspect}")
+        response = Net::HTTP.post_form(@endpoint, payload)
+        json = JSON.parse(response.body || '')
+        @logger.info("im.kayac: sent #{payload[:message].inspect} to #{@config["user"].inspect} -- #{json.inspect}")
+
+        raise RequestError, json["error"] if json["error"] && !json["error"].empty?
+
+      rescue JSON::ParserError => e
+        r.value
+        raise e
+      end
+
+      def mark_as_deleted(*)
+      end
+
+      def record_event(*)
+      end
+
+      def record_message(*)
+      end
+    end
+  end
+end

data/spec/imkayac_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'akane/storages/imkayac'
+
+require 'digest/sha1'
+require 'json'
+
+require 'twitter/tweet'
+require 'twitter/user'
+
+describe Akane::Storages::Imkayac do
+  let(:base_config) { {"user" => 'tester', "keywords" => %w(keyword), "excludes" => %w(ignore)} }
+  let(:config) { base_config }
+
+  let(:endpoint) { "http://im.kayac.com/api/post" }
+
+  let(:tweet_text) { 'keyword' }
+  let(:screen_name) { 'user' }
+  let(:tweet) { Twitter::Tweet.new(id: 1, text: tweet_text, user: {id: 2, screen_name: screen_name}, retweeted_status: nil) }
+  let(:retweet) { Twitter::Tweet.new(id: 2, text: "RT @#{screen_name}: #{tweet_text}", user: {id: 3, screen_name: 'retweeter'}, retweeted_status: tweet) }
+
+  let(:error) { nil }
+  let(:response) { {id: nil, error: error, result: error ? "" : "posted"} }
+
+  subject { described_class.new(config: config, logger: Logger.new(nil)) }
+
+  before do
+    stub_request(:post, "#{endpoint}/tester").to_return(:body => response.to_json)
+  end
+
+  describe "#record_tweet" do
+    describe "keyword matching:" do
+      context "when matched keywords" do
+        it "sends" do
+          subject.record_tweet('tester', tweet)
+
+          expect(a_request(:post, "#{endpoint}/tester").with(
+            body: {message: '[tw] user: keyword'}
+          )).to have_been_made
+        end
+
+        context "when error occured" do
+          let(:error) { "test error" }
+
+          it "raises error" do
+            expect {
+              subject.record_tweet('tester', tweet)
+            }.to raise_error(Akane::Storages::Imkayac::RequestError, "test error")
+          end
+        end
+      end
+
+      context "when matched both keywords and ignored keywords" do
+        let(:tweet_text) { 'keyword ignore' }
+
+        it "doesn't send" do
+          subject.record_tweet('tester', tweet)
+          expect(a_request(:post, "#{endpoint}/tester")).not_to have_been_made
+        end
+      end
+
+      context "when matched tweet is a retweet" do
+        it "doesn't send" do
+          subject.record_tweet('tester', retweet)
+          expect(a_request(:post, "#{endpoint}/tester")).not_to have_been_made
+        end
+      end
+    end
+
+    describe "message option:" do
+      let(:config) { base_config.merge("message" => '<%= tweet.id %> <%= tweet.user.id %> <%= tweet.text %> <%= tweet.user.screen_name %>') }
+
+      it "allows customize message" do
+        subject.record_tweet('tester', tweet)
+
+        expect(a_request(:post, "#{endpoint}/tester").with(
+          body: {message: '1 2 keyword user'}
+        )).to have_been_made
+      end
+    end
+
+    describe "handler option:" do
+      let(:config) { base_config.merge("handler" => 'myapp://<%= tweet.id %>') }
+
+      it "allows customize handler" do
+        subject.record_tweet('tester', tweet)
+
+        expect(a_request(:post, "#{endpoint}/tester").with(
+          body: {message: '[tw] user: keyword', handler: 'myapp://1'}
+        )).to have_been_made
+      end
+    end
+
+    describe "secret option:" do
+      let(:config) { base_config.merge("secret" => 'mysecret') }
+
+      it "sends `sig` for authentication" do
+        subject.record_tweet('tester', tweet)
+
+        message = '[tw] user: keyword'
+        expect(a_request(:post, "#{endpoint}/tester").with(
+          body: {message: message, sig: Digest::SHA1.hexdigest(message + 'mysecret')}
+        )).to have_been_made
+      end
+    end
+
+    describe "password option:" do
+      let(:config) { base_config.merge("password" => 'mypw') }
+
+      it "sends `password` for authentication" do
+        subject.record_tweet('tester', tweet)
+
+        expect(a_request(:post, "#{endpoint}/tester").with(
+          body: {message:  '[tw] user: keyword', password: 'mypw'}
+        )).to have_been_made
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require 'webmock/rspec'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: akane-imkayac
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shota Fukumori (sora_h)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: akane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !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'
+description: storage plugin for akane | sends matched tweets to im.kayac
+email:
+- her@sorah.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- akane-imkayac.gemspec
+- lib/akane-imkayac.rb
+- lib/akane-imkayac/version.rb
+- lib/akane/imkayac.rb
+- lib/akane/storages/imkayac.rb
+- spec/imkayac_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.0
+signing_key: 
+specification_version: 4
+summary: imkayac storage plugin for akane | for notification
+test_files:
+- spec/imkayac_spec.rb
+- spec/spec_helper.rb