Chizuru 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 651cb625e157a022ce6c852bed6816a1932b6786
-  data.tar.gz: 120c1ec62086b528b420644a70e0b30dc87d2fe6
+  metadata.gz: ab93acb12743db1e5e5479b9f8499e65902f69d6
+  data.tar.gz: 16c0e2e9f28438e27c9a36035ebd240c57102ed5
 SHA512:
-  metadata.gz: fe34ea4c3fdfca1d4faa4326707c815fbc0ca9d0da5e714aaa3042e567bb85490dc41743c45aa57e4f945905668f434db268d2074d522c13d0fccdd8e6a1d9d6
-  data.tar.gz: 8aadd02228f3b1955c03a3dd3d47a6d8650a89bee7edfe2217cb0c52f2878e04f590dde2c4ed220435f631a46a8dc0c82dcac4b2bd0af747c3f340fb41323e9c
+  metadata.gz: ff98c1d883b9aa4629a89a5a961d57dd11e86b5f4e6d03241c453d12ee526c52cfce2f5534cd5daae34067bc3d25a65fe4e8014a21552914ef64d3467c2f4500
+  data.tar.gz: 06596432c4b40ba775b88c61b6263a90ae6e97693934cca6f5c48d05f54e0c571b101cee5d369f8aa663ea9f99e698a34db5e99914cdb319bc37ba9ba032cd4e

data/Chizuru.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.has_rdoc      = true
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_dependency 'oauth'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Chizuru (0.0.2)
+    Chizuru (0.0.3)
       oauth
       yajl-ruby
 

data/README.md

@@ -2,6 +2,8 @@ Chizuru
 =======
 re-structured twitter bot framework
 
+On RubyGems.org: https://rubygems.org/gems/Chizuru
+
 Installation
 ============
 
@@ -21,11 +23,12 @@ 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!
+1. Add `require 'chizuru'`.
+2. Define `Consumer` and `Deliverer`.
+3. 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`.
+4. Prepare the source. We provide the default source that uses UserStreaming. If you decide to use it, add `require 'chizuru/user_stream'` and set the instance of `Chizuru::UserStream` as the source in the next step. Otherwise, you must define the source class that is inherited from `Chizuru::Source`.
+5. Configure the bot. Use `Chizuru::Bot.configure`. Set the source and consumer.
+6. Start it!
 
 Basic Structure
 ===============

data/lib/chizuru.rb

@@ -3,5 +3,4 @@ require 'chizuru/credential'
 require 'chizuru/consumer'
 require 'chizuru/provider'
 require 'chizuru/source'
-require 'chizuru/user_stream'
 require 'chizuru/bot'

data/lib/chizuru/bot.rb

@@ -1,21 +1,36 @@
 require 'chizuru/credential'
 
 module Chizuru
+  # Helper for DSL
   class ConsumerHelper
-    attr_reader :consumer, :credential
+    # Gets the consumer.
+    attr_reader :consumer
+    # Gets the credentials.
+    attr_reader :credential
 
+    # Initializes an instance of ConsumerHelper.
+    # _cons_ is the consumer, _credential_ is the credential.
     def initialize(cons, credential)
       @consumer = cons
       @credential = credential
     end
 
+    # Add deliverer
     def deliverer(deliv)
       @consumer.add_deliverer(deliv)
     end
   end
 
+  # Represents a twitter-bot.
   class Bot
-    attr_accessor :src, :credential, :provider
+    # Gets or sets a source.
+    attr_accessor :src
+    # Gets or sets a provider.
+    attr_accessor :provider
+    # Gets or sets credentials. (This is given to the source.)
+    attr_accessor :credential
+
+    # Configures this bot.
     def self.configure(cred_path, &block)
       bot = Bot.new
       bot.credential = Credential.new(cred_path)
@@ -24,6 +39,10 @@ module Chizuru
       bot
     end
 
+    # Adds a consumer.
+    #
+    # * If an instance of Consumer or its subclasses is given, it is used.
+    # * If Class is given, initialize its instance, and use it. In this case, the rest arguments are passed to the constructor of the given class.
     def consumer(cons, *init_args, &block)
       if cons.instance_of? Class
         cons = cons.new(*init_args)
@@ -33,10 +52,12 @@ module Chizuru
       provider.add_consumer(ch.consumer)
     end
 
+    # Sets a source.
     def source(src)
       @source = src
     end
 
+    # Starts this bot.
     def start
       @source.start
     end

data/lib/chizuru/consumer.rb

@@ -1,5 +1,8 @@
 module Chizuru
+  # Represents a consumer.
+  # Consumer takes tweets from Source, and generates status and passes it to deliverers.
   class Consumer
+    # Initializes an instance of Consumer and starts loop.
     def initialize
       @deliverers = []
       @queue = Queue.new
@@ -11,18 +14,22 @@ module Chizuru
       end
     end
 
+    # Adds deliverer.
     def add_deliverer(deliverer)
       @deliverers << deliverer
     end
-    
+
+    # Removes a deliverer.
     def remove_deliverer(deliverer)
       @deliverers.delete(deliverer)
     end
 
+    # On delivering a status.
     def deliver(data)
       @queue.enq data
     end
 
+    # Dispatches a status to deliverers this has.
     def dispatch(data)
       @deliverers.each do |deliverer|
         Thread.new do 

data/lib/chizuru/credential.rb

@@ -1,8 +1,16 @@
 require 'yaml'
 
 module Chizuru
+  # Represents credentials.
   class Credential
-    attr_reader :consumer, :access_token
+    # Gets the consumer.
+    attr_reader :consumer
+    # Gets the access token.
+    attr_reader :access_token
+
+    # Initializes the credentials from the given file.
+    #
+    # The file must be YAML file, and it must have these keys: `consumer_key`, `consumer_secret`, `access_token`, and `access_token_secret`.
     def initialize(path)
       cred = YAML.load_file(path)
       @consumer = OAuth::Consumer.new(

data/lib/chizuru/provider.rb

@@ -1,7 +1,11 @@
 require 'thread'
 
 module Chizuru
+  # Represents a tweets provider.
+  #
+  # Provider takes tweets from Source and provides them to Consumer.
   class Provider
+    # Initializes an instance of Provider and starts the loop.
     def initialize
       @consumers = []
       @queue = Queue.new
@@ -13,18 +17,22 @@ module Chizuru
       end
     end
 
+    # Adds a consumer.
     def add_consumer(cons)
       @consumers << cons
     end
 
+    # Removes a consumer.
     def remove_consumer(cons)
       @consumers.delete(cons)
     end
 
+    # On receiving a status from the source.
     def receive(data)
       @queue.enq data
     end
 
+    # Dispatches the status to the consumers this has.
     def dispatch(data)
       @consumers.each do |consumer|
         Thread.new do

data/lib/chizuru/source.rb

@@ -1,5 +1,9 @@
 module Chizuru
+  # Represents a tweets source.
+  #
+  # Source provides events or statuses from Twitter API, or other any sources (for example, the log file of the streaming).
   class Source
+    # Initializes an instance of Source with the given Provider.
     def initialize(provider)
       raise ArgumentError unless provider
       @provider = provider

data/lib/chizuru/user_stream.rb

@@ -5,9 +5,18 @@ require 'yajl'
 require 'chizuru/source'
 
 module Chizuru
+  # UserStream takes events or statuses from UserStreaming API.
   class UserStream < Source
+    # The default value of User-Agent.
     DEFAULT_USER_AGENT = 'TwitterBot/1.0 (Based on Chizuru)'
 
+    # Initializes an instance of UserStream.
+    #
+    # * _provider_ is the provider that this will give the events or statuses.
+    # * _cred_ is the credentials.
+    # * _screen_name_ is the screen name of this bot.
+    # * _ca_file_path_ is the path for the certification file. It is required to establish the SSL connection with Twitter API.
+    # * _user_agent_ is the User-Agent. Twitter strongly recommends set the User-Agent that includes the version of the client. See https://dev.twitter.com/docs/streaming-apis/connecting#User_Agent
     def initialize(provider, cred, screen_name, ca_file_path, user_agent = DEFAULT_USER_AGENT)
       super(provider)
       raise ArgumentError unless cred
@@ -19,6 +28,7 @@ module Chizuru
       @user_agent = user_agent
     end
 
+    # Starts the bot.
     def start
       puts '[UserStream] Start Streaming'
       connect do |json|
@@ -26,6 +36,9 @@ module Chizuru
       end
     end
 
+    # Connects to UserStreaming API.
+    #
+    # The block will be given the events or statuses from Twitter API in JSON format.
     def connect
       uri = URI.parse("https://userstream.twitter.com/2/user.json?track=#{@screen_name}")
 

data/lib/chizuru/version.rb

@@ -1,3 +1,4 @@
 module Chizuru
-  VERSION = "0.0.2"
+  # Version of this gem.
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Chizuru
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - mayth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-24 00:00:00.000000000 Z
+date: 2013-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler