Chizuru 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 651cb625e157a022ce6c852bed6816a1932b6786
+  data.tar.gz: 120c1ec62086b528b420644a70e0b30dc87d2fe6
+SHA512:
+  metadata.gz: fe34ea4c3fdfca1d4faa4326707c815fbc0ca9d0da5e714aaa3042e567bb85490dc41743c45aa57e4f945905668f434db268d2074d522c13d0fccdd8e6a1d9d6
+  data.tar.gz: 8aadd02228f3b1955c03a3dd3d47a6d8650a89bee7edfe2217cb0c52f2878e04f590dde2c4ed220435f631a46a8dc0c82dcac4b2bd0af747c3f340fb41323e9c

data/Chizuru.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Chizuru/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "Chizuru"
+  spec.version       = Chizuru::VERSION
+  spec.authors       = ["mayth"]
+  spec.email         = ["chimeaquas@hotmail.com"]
+  spec.description   = %q{Twitter bot framework}
+  spec.summary       = %q{Twitter bot frameowrk}
+  spec.homepage      = "https://github.com/mayth/Chizuru"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency 'oauth'
+  spec.add_dependency 'yajl-ruby'
+end

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    Chizuru (0.0.2)
+      oauth
+      yajl-ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    oauth (0.4.7)
+    rake (10.0.4)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Chizuru!
+  bundler (~> 1.3)
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 mayth
+
+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,62 @@
+Chizuru
+=======
+re-structured twitter bot framework
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+    gem 'Chizuru'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Chizuru
+
+How To
+======
+Notice: See `test.rb`.
+
+1. Define `Consumer` and `Deliverer`.
+2. Acquire the consumer secret and access token, and save it. We use YAML file that have these keys: `consumer_key`, `consumer_secret`, `access_token`, `access_token_secret`.
+3. Prepare the source. We provide the default source that uses UserStreaming. If you decide not to use it, you must define the source class that is inherited from `Chizuru::Source`.
+4. Configure the bot. Use `Chizuru::Bot.configure`.
+5. Start it!
+
+Basic Structure
+===============
+
+Source
+------
+**Source** provides the tweets. We provide `UserStream` class. It uses UserStreaming.
+
+Consumer
+--------
+**Consumer** receives tweets.
+Consumer must be inherited from `Chizuru::Consumer`, and must have `receive(data)` method.
+
+Deliverer
+---------
+**Deliverer** posts tweets.
+`Deliverer` must have `deliver(data)` method.
+
+Contributing to Chizuru
+=======================
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+=========
+Copyright (c) 2013 mayth.
+
+Chizuru is licensed under the MIT License. See LICENSE.txt.

data/Rakefile

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

data/lib/chizuru.rb

@@ -0,0 +1,7 @@
+require "chizuru/version"
+require 'chizuru/credential'
+require 'chizuru/consumer'
+require 'chizuru/provider'
+require 'chizuru/source'
+require 'chizuru/user_stream'
+require 'chizuru/bot'

data/lib/chizuru/bot.rb

@@ -0,0 +1,44 @@
+require 'chizuru/credential'
+
+module Chizuru
+  class ConsumerHelper
+    attr_reader :consumer, :credential
+
+    def initialize(cons, credential)
+      @consumer = cons
+      @credential = credential
+    end
+
+    def deliverer(deliv)
+      @consumer.add_deliverer(deliv)
+    end
+  end
+
+  class Bot
+    attr_accessor :src, :credential, :provider
+    def self.configure(cred_path, &block)
+      bot = Bot.new
+      bot.credential = Credential.new(cred_path)
+      bot.provider = Provider.new
+      bot.instance_eval &block
+      bot
+    end
+
+    def consumer(cons, *init_args, &block)
+      if cons.instance_of? Class
+        cons = cons.new(*init_args)
+      end
+      ch = ConsumerHelper.new(cons, credential)
+      ch.instance_eval &block
+      provider.add_consumer(ch.consumer)
+    end
+
+    def source(src)
+      @source = src
+    end
+
+    def start
+      @source.start
+    end
+  end
+end

data/lib/chizuru/consumer.rb

@@ -0,0 +1,34 @@
+module Chizuru
+  class Consumer
+    def initialize
+      @deliverers = []
+      @queue = Queue.new
+      Thread.new do
+        while true
+          data = @queue.deq
+          dispatch(data)
+        end
+      end
+    end
+
+    def add_deliverer(deliverer)
+      @deliverers << deliverer
+    end
+    
+    def remove_deliverer(deliverer)
+      @deliverers.delete(deliverer)
+    end
+
+    def deliver(data)
+      @queue.enq data
+    end
+
+    def dispatch(data)
+      @deliverers.each do |deliverer|
+        Thread.new do 
+          deliverer.deliver(data)
+        end
+      end
+    end
+  end
+end

data/lib/chizuru/credential.rb

@@ -0,0 +1,18 @@
+require 'yaml'
+
+module Chizuru
+  class Credential
+    attr_reader :consumer, :access_token
+    def initialize(path)
+      cred = YAML.load_file(path)
+      @consumer = OAuth::Consumer.new(
+        cred['consumer_key'],
+        cred['consumer_secret'],
+        site: 'https://api.twitter.com/1.1')
+      @access_token =  OAuth::AccessToken.new(
+          consumer,
+          cred['access_token'],
+          cred['access_token_secret'])
+    end
+  end
+end

data/lib/chizuru/provider.rb

@@ -0,0 +1,36 @@
+require 'thread'
+
+module Chizuru
+  class Provider
+    def initialize
+      @consumers = []
+      @queue = Queue.new
+      Thread.new do
+        while (true)
+          data = @queue.deq
+          dispatch(data)
+        end
+      end
+    end
+
+    def add_consumer(cons)
+      @consumers << cons
+    end
+
+    def remove_consumer(cons)
+      @consumers.delete(cons)
+    end
+
+    def receive(data)
+      @queue.enq data
+    end
+
+    def dispatch(data)
+      @consumers.each do |consumer|
+        Thread.new do
+          consumer.receive(data)
+        end
+      end
+    end
+  end
+end

data/lib/chizuru/source.rb

@@ -0,0 +1,8 @@
+module Chizuru
+  class Source
+    def initialize(provider)
+      raise ArgumentError unless provider
+      @provider = provider
+    end
+  end
+end

data/lib/chizuru/user_stream.rb

@@ -0,0 +1,64 @@
+require 'oauth'
+require 'yaml'
+require 'yajl'
+
+require 'chizuru/source'
+
+module Chizuru
+  class UserStream < Source
+    DEFAULT_USER_AGENT = 'TwitterBot/1.0 (Based on Chizuru)'
+
+    def initialize(provider, cred, screen_name, ca_file_path, user_agent = DEFAULT_USER_AGENT)
+      super(provider)
+      raise ArgumentError unless cred
+      @credential = cred
+      raise ArgumentError unless screen_name
+      @screen_name = screen_name
+      raise ArgumentError unless ca_file_path
+      @ca_file = ca_file_path
+      @user_agent = user_agent
+    end
+
+    def start
+      puts '[UserStream] Start Streaming'
+      connect do |json|
+        @provider.receive(json)
+      end
+    end
+
+    def connect
+      uri = URI.parse("https://userstream.twitter.com/2/user.json?track=#{@screen_name}")
+
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      https.ca_file = @ca_file
+      https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      https.verify_depth = 5
+
+      https.start do |https|
+        request = Net::HTTP::Get.new(uri.request_uri,
+                                     "User-Agent" => @user_agent,
+                                     "Accept-Encoding" => "identity")
+        request.oauth!(https, @credential.consumer, @credential.access_token)
+
+        buf = ""
+        https.request(request) do |response|
+          response.read_body do |chunk|
+            buf << chunk
+            while ((line = buf[/.+?(\r\n)+/m]) != nil)
+              begin
+                buf.sub!(line, "")
+                line.strip!
+                status = Yajl::Parser.parse(line)
+              rescue
+                break
+              end
+
+              yield status
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chizuru/version.rb

@@ -0,0 +1,3 @@
+module Chizuru
+  VERSION = "0.0.2"
+end

data/test.rb

@@ -0,0 +1,72 @@
+require './provider'
+require './consumer'
+require './credential'
+require './user_stream'
+require './bot'
+
+class SimpleConsumer < Chizuru::Consumer
+  def receive(data)
+    deliver(data)
+  end
+end
+
+class MeitanConsumer < Chizuru::Consumer
+  HASHTAG_CANDIDATE_CHAR = ('a'..'z').to_a
+  HASHTAG_LENGTH = 5
+  def receive(data)
+    return unless data['text']
+    if data['text'].include?('めいたん')
+      deliver({status: "@#{data['user']['screen_name']} めいたんじゃない！ ##{HASHTAG_CANDIDATE_CHAR.sample(HASHTAG_LENGTH).join}", in_reply_to: data})
+    end
+  end
+end
+
+class EchoDeliverer
+  def deliver(data)
+    p data
+  end
+end
+
+class LoggingDeliverer
+  def initialize(log_file)
+    @log_file = log_file
+  end
+
+  def deliver(data)
+    open(@log_file, 'a:utf-8') do |file|
+      file.puts(data.inspect)
+    end
+  end
+end
+
+class TweetDeliverer
+  def initialize(cred)
+    @credential = cred
+  end
+
+  def deliver(data)
+    opts = {status: data[:status]}
+    if data[:in_reply_to]
+      opts[:in_reply_to_status_id] = data[:in_reply_to]['id']
+    end
+    @credential.access_token.post(
+      '/statuses/update.json', opts)
+  end
+end
+
+bot = Chizuru::Bot.configure 'credential.yaml' do
+  source Chizuru::UserStream.new(provider, credential, 'meitanbot', 'cert', 'meitanbot/2.0 (Chizuru/1.0)')
+  echo_deliv = EchoDeliverer.new
+  log_deliv = LoggingDeliverer.new('./stream.log')
+  consumer SimpleConsumer do
+    deliverer echo_deliv
+    deliverer log_deliv
+  end
+
+  consumer MeitanConsumer do
+    deliverer echo_deliv
+    deliverer TweetDeliverer.new(credential)
+  end
+end
+
+bot.start

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: Chizuru
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- mayth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.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'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Twitter bot framework
+email:
+- chimeaquas@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Chizuru.gemspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/chizuru.rb
+- lib/chizuru/bot.rb
+- lib/chizuru/consumer.rb
+- lib/chizuru/credential.rb
+- lib/chizuru/provider.rb
+- lib/chizuru/source.rb
+- lib/chizuru/user_stream.rb
+- lib/chizuru/version.rb
+- test.rb
+homepage: https://github.com/mayth/Chizuru
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Twitter bot frameowrk
+test_files: []