twpipe 0.0.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 koshigoe
+
+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.rdoc

@@ -0,0 +1,41 @@
+= Twpipe
+
+This is a simply Twitter Command-Line client.
+
+== Synopsis
+
+ % twpipe input your messages separated space
+
+ % cat <<EOF | twpipe
+ messages from STDIN.
+ EOF
+
+See more information:
+
+ % twpipe -h
+
+== Configuration
+
+The configuration file is generally located "~/.twpipe", and file format is the YAML.
+The configuration is single Hash. This mean is all items are key-value pair(both key and value are string).
+
+ctoken:: Consumer token
+csecret:: Consumer secret
+atoken:: Access token
+asecret:: Access secret
+
+In alpha-1, it has not available to configure from CLI yet.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 koshigoe. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  require File.dirname(__FILE__) + "/lib/twpipe/version.rb"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "twpipe"
+    gem.summary = 'This is a simply Twitter Command-Line client.'
+    gem.description = 'This is a simply Twitter Command-Line client.'
+    gem.email = "KoshigoeBushou@gmail.com"
+    gem.homepage = "http://github.com/koshigoe/twpipe"
+    gem.authors = ["koshigoe"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_runtime_dependency "twitter"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.version = Twpipe::VERSION
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Twpipe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/twpipe

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'twpipe'
+require 'optparse'
+
+options = {}
+ARGV.options do |opt|
+  opt.version = '0.0.0'
+  opt.banner = <<EOF
+This is a simply Twitter Command-Line client.
+
+  http://github.com/koshigoe/twpipe
+
+Usage:
+
+    1) tweet simply
+      % #{File.basename($0)} [options] some message
+
+    2) tweet from stdin
+      % cat <<EOF | #{File.basename($0)}
+      some messages
+      by multilines.
+      At twitter, these messages are shown single line.
+      EOF
+
+Options:
+
+EOF
+
+  opt.on('-c CONFIG_FILE', '--config CONFIG_FILE', 'path to configuration file') {|v| options['config_path'] }
+
+  opt.permute!
+end
+
+if ARGV.size > 0
+  message = ARGV.join(' ')
+else
+  message = ''
+  while buffer = gets
+    message << buffer
+  end
+end
+
+begin
+  Twpipe.config_path = options['config_path'] if options['config_path']
+  pipe = Twpipe.new
+  pipe.tweet(message)
+rescue Twpipe::ConfigError => e
+  puts e.message
+end

data/lib/twpipe/version.rb

@@ -0,0 +1,3 @@
+class Twpipe
+  VERSION = '0.0.0'
+end

data/lib/twpipe.rb

@@ -0,0 +1,92 @@
+require 'rubygems'
+require 'twitter'
+require 'twpipe/version'
+
+# == Twpipe
+#
+class Twpipe
+  class ConfigError < Exception; end
+
+  class << self
+    # config_path:: the file path to configuration file
+    attr_accessor :config_path
+  end
+
+  unless instance_variable_defined?(:@config_path)
+    @config_path = File.expand_path('~/.twpipe')
+  end
+
+  # client:: twitter client that authenticated by oAuth (Twitter::Base)
+  attr_reader :client
+
+  def initialize
+    setup_config
+    setup_client
+  end
+
+  # tweet your message
+  #
+  # message: string variable that you would tweet
+  #
+  def tweet(message)
+    @client.update(message)
+  end
+
+private
+
+  def manual_of_configuration
+    @manual_of_configuration ||=<<EOF
+  - You must create configuration file which must set to "~/.twpipe".
+  - The format of configuration file must be YAML.
+  - Required configurations are:
+    ctoken:: consumer token
+    csecret:: consumer secret
+    atoken:: access token
+    asecret:: access secret
+  - Optional configurations are:
+    name:: your name at twitter
+  - If you would get more informations of configurations:
+    % grep config bin/twpipe
+EOF
+  end
+
+  # required items of configuration
+  #
+  # ctoken:: consumer token
+  # csecret:: consumer secret
+  # atoken:: access token
+  # asecret:: access secret
+  #
+  def required_items_of_configuration
+    @required_items_of_configuration ||= %w(ctoken csecret atoken asecret).sort
+  end
+
+  def setup_config # :nodoc:
+    unless File.exist?(self.class.config_path)
+      raise ConfigError,
+        "Configuration file not found, see following messages:\n\n" \
+        "#{manual_of_configuration}"
+
+    end
+
+    begin
+      @config = YAML.load_file(self.class.config_path)
+    rescue
+      raise ConfigError,
+        "Configuration file was invalid, see following messages:\n\n" \
+        "#{manual_of_configuration}"
+    end
+
+    if (@config.keys & required_items_of_configuration).sort != required_items_of_configuration
+      raise ConfigError,
+        "Some items of configuration not found, see following messages:\n\n" \
+        "#{manual_of_configuration}"
+    end
+  end
+
+  def setup_client
+    oauth = Twitter::OAuth.new(@config['ctoken'], @config['csecret'])
+    oauth.authorize_from_access(@config['atoken'], @config['asecret'])
+    @client = Twitter::Base.new(oauth)
+  end
+end

data/spec/data/config/invalid.yml

@@ -0,0 +1,4 @@
+ctoken: "..."
+atoken: "..."
+asecret: "..."
+name: "..."

data/spec/data/config/syntax_error.yml

@@ -0,0 +1,6 @@
+ctoken: "..."
+csecret: "..."
+atoken: "..."
+asecret: "..."
+name: "..."
+invalid field(disallowed in YAML)

data/spec/data/config/valid.yml

@@ -0,0 +1,5 @@
+ctoken: "..."
+csecret: "..."
+atoken: "..."
+asecret: "..."
+name: "..."

data/spec/lib/twpipe_spec.rb

@@ -0,0 +1,76 @@
+require 'tempfile'
+require 'twpipe'
+
+describe Twpipe do
+  after do
+    Twpipe.config_path = '~/.twpipe'
+  end
+
+  describe 'utilities' do
+    describe 'config_path' do
+      it 'should be equal "~/.twpipe" at default' do
+        Twpipe.config_path.should == File.expand_path('~/.twpipe')
+      end
+
+      it 'should be able to change value' do
+        Twpipe.config_path = 'hoge'
+        Twpipe.config_path.should == 'hoge'
+      end
+    end
+  end
+
+  describe 'initialize' do
+    let(:manual) do
+      <<EOF
+  - You must create configuration file which must set to "~/.twpipe".
+  - The format of configuration file must be YAML.
+  - Required configurations are:
+    ctoken:: consumer token
+    csecret:: consumer secret
+    atoken:: access token
+    asecret:: access secret
+  - Optional configurations are:
+    name:: your name at twitter
+  - If you would get more informations of configurations:
+    % grep config bin/twpipe
+EOF
+    end
+
+    it 'should raise error, if not exist specified configure file' do
+      message = "Configuration file not found, see following messages:\n\n#{manual}"
+      lambda { Twpipe.new }.should raise_error(Twpipe::ConfigError, message)
+    end
+
+    it 'should raise error, if configuration format was invalid' do
+      Twpipe.config_path = File.join(File.dirname(__FILE__), '../data/config/syntax_error.yml')
+
+      message = "Configuration file was invalid, see following messages:\n\n#{manual}"
+      lambda { Twpipe.new }.should raise_error(Twpipe::ConfigError, message)
+    end
+
+    it 'should raise error, if not enough required items of configuration' do
+      Twpipe.config_path = File.join(File.dirname(__FILE__), '../data/config/invalid.yml')
+
+      message = "Some items of configuration not found, see following messages:\n\n#{manual}"
+      lambda { Twpipe.new }.should raise_error(Twpipe::ConfigError, message)
+    end
+
+    it 'should not raise error, if configuration is valid' do
+      Twpipe.config_path = File.join(File.dirname(__FILE__), '../data/config/valid.yml')
+      twpipe = nil
+      lambda { twpipe = Twpipe.new }.should_not raise_error
+      twpipe.client.should be_an_instance_of Twitter::Base
+    end
+  end
+
+  describe 'tweet' do
+    let(:twitter) { mock('Twitter:Base') }
+
+    it 'should receive Twitter::Base#update' do
+      Twpipe.config_path = File.join(File.dirname(__FILE__), '../data/config/valid.yml')
+      twpipe = Twpipe.new
+      twpipe.instance_variable_get(:@client).should_receive(:update).with('message')
+      twpipe.tweet('message')
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/twpipe.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{twpipe}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["koshigoe"]
+  s.date = %q{2010-09-23}
+  s.default_executable = %q{twpipe}
+  s.description = %q{This is a simply Twitter Command-Line client.}
+  s.email = %q{KoshigoeBushou@gmail.com}
+  s.executables = ["twpipe"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "bin/twpipe",
+     "lib/twpipe.rb",
+     "lib/twpipe/version.rb",
+     "spec/data/config/invalid.yml",
+     "spec/data/config/syntax_error.yml",
+     "spec/data/config/valid.yml",
+     "spec/lib/twpipe_spec.rb",
+     "spec/spec.opts",
+     "twpipe.gemspec"
+  ]
+  s.homepage = %q{http://github.com/koshigoe/twpipe}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{This is a simply Twitter Command-Line client.}
+  s.test_files = [
+    "spec/lib/twpipe_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<twitter>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<twitter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<twitter>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: twpipe
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- koshigoe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-23 00:00:00 +09:00
+default_executable: twpipe
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: This is a simply Twitter Command-Line client.
+email: KoshigoeBushou@gmail.com
+executables: 
+- twpipe
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- bin/twpipe
+- lib/twpipe.rb
+- lib/twpipe/version.rb
+- spec/data/config/invalid.yml
+- spec/data/config/syntax_error.yml
+- spec/data/config/valid.yml
+- spec/lib/twpipe_spec.rb
+- spec/spec.opts
+- twpipe.gemspec
+has_rdoc: true
+homepage: http://github.com/koshigoe/twpipe
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This is a simply Twitter Command-Line client.
+test_files: 
+- spec/lib/twpipe_spec.rb