twiauth 0.1.0 → 1.0.0.rc1

data/.gitignore

@@ -17,9 +17,10 @@ tmtags
 coverage
 rdoc
 pkg
-
-## PROJECT::SPECIFIC
+doc
+.yardoc
+capybara*.html
 .idea
-**/config.yml
-access_token.yml
-*.pstore
+**/*.yml
+spec/config/*.yml
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Rakefile

@@ -1,44 +1,17 @@
-require 'rake'
-require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "twiauth"
-    gem.summary = %Q{a very simple twitter authentication wrapper}
-    gem.description = %Q{simple twitter authentication wrapper}
-    gem.email = "swessel@gr4yweb.de"
-    gem.homepage = "http://github.com/gr4y/twiauth"
-    gem.authors = ["Sascha Wessel"]
-    gem.add_dependency "oauth", ">= 0.4.0"
-    gem.add_dependency "rspec", "1.3.0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-desc "generate rdoc"
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "twiauth #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc "generate documentation"
+require 'yard'
+YARD::Rake::YardocTask.new do |yard|
+  yard.files = ['lib/**/*.rb']
+  yard.options = ["--no-private"]
 end
 
 desc "run all specs"
-begin
-  gem 'rspec','1.3.0'
-  require 'spec/rake/spectask'
-  Spec::Rake::SpecTask.new do |t|
-    t.spec_files = FileList['spec/**/*_spec.rb']
-  end
-rescue LoadError
-  warn "[twiauth] rspec is not installed. install it with: gem install rspec --version 1.3.0"
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-task :test => [:check_dependencies, :spec]
-task :default => [:test, :build]
+task :test => [:spec]
+task :doc => [:yard]
+task :default => [:test, :doc, :build]

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0.rc1

data/lib/twiauth/client.rb

@@ -0,0 +1,86 @@
+module TwiAuth
+  # oauth client
+  class Client
+    
+    attr_accessor :consumer, :request_token, :access_token, :parser
+    
+    # we only need to set the site
+    # all other configuration is default configuration 
+    TWITTER_OAUTH_SPEC = { :site => 'https://api.twitter.com' }
+    
+    #
+    # connect to the twitter api
+    #
+    #   @client = TwiAuth::Client.new( {:key => @consumer_key, :secret => @consumer_secret})
+    #
+    def initialize(consumer, options = {})
+      # raise "options are nil" if options.nil?       
+      self.access_token = nil # options[:access_token]      
+      if self.access_token.nil?
+        raise "consumer could not be nil!" if consumer.nil?
+        self.consumer = connect(consumer['key'], consumer['secret'])
+      end
+    end
+
+    def get_request_token
+      if self.request_token.nil?
+        self.request_token = self.consumer.get_request_token
+      end
+      self.request_token      
+    end
+      
+    #
+    # get access token
+    #
+    def get_access_token(pin = nil)
+      if self.access_token.nil?
+        self.access_token = self.request_token.get_access_token(:oauth_verifier => pin)
+      end
+      self.access_token
+    end
+
+    #
+    # get something from the api
+    # 
+    def get(url, options = nil)
+      request(url, options, :get)
+    end    
+    
+    #
+    # post something to the api
+    #
+    def post(url, options = nil)
+      request(url, options, :post)
+    end
+    
+    private
+    
+    #
+    # create an oauth consumer
+    #
+    def connect(key, secret)
+      OAuth::Consumer.new(key, secret, TWITTER_OAUTH_SPEC)
+    end  
+    
+    #
+    # send an post or get request with the specified options to the given url
+    #
+    def request(url, options = nil, http_method)
+      if http_method.eql?(:post)
+        response = get_access_token.post(url, options).body
+      elsif http_method.eql?(:get)
+        response = get_access_token.get(url).body
+      else
+        raise "invalid http_method"
+      end
+      parse_json(response)
+    end
+    
+    #
+    # parse the json string into an nice ruby hash
+    #
+    def parse_json(string)
+      Yajl::Parser.parse(string)
+    end   
+  end
+end

data/lib/twiauth.rb

@@ -1,7 +1,6 @@
 require 'oauth'
-require 'twiauth/oauth'
-require 'twiauth/store'
-require 'yaml'
+require 'twiauth/client'
+require 'yajl'
 
 module TwiAuth
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR

data/spec/client_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe TwiAuth::Client do
+
+  before :all do
+    @client = TwiAuth::Client.new(@consumer, @options)
+    @session = Capybara::Session.new(:akephalos)
+  end
+    
+  it 'should not be nil' do
+    @client.should_not be_nil
+  end
+  
+  it 'should have an method called get_request_token' do
+    (@client.public_methods.include?(:get_request_token)).should be_true
+  end
+
+  it 'should get an request_token' do
+    @client.get_request_token.should_not be_nil
+  end
+
+  it 'visits the authorize url' do
+    @session.visit(@client.get_request_token.authorize_url)
+  end
+    
+  it 'has an signin form' do
+    @session.has_selector?('div#signin_form').should be_true
+  end
+    
+  it 'fills out the form' do
+    @session.within('#signin_form') do
+      @session.fill_in 'username_or_email', :with => @test['user']
+      @session.fill_in 'password', :with => @test['password']
+    end
+  end
+  
+  it 'has an allow button' do
+    @session.has_button?('allow').should be_true
+  end
+  
+  it 'clicks the allow botton' do
+    @session.click_button('allow')
+  end
+
+  it 'should get an access_token' do
+    oauth_pin = @session.find_by_id('oauth_pin')    
+    pin = oauth_pin.text.chomp!
+    @client.get_access_token(pin).should_not be_nil
+  end
+
+  it 'should have an public get method' do
+    (@client.public_methods.include? :get).should be_true
+  end
+
+  it "should get an ok" do
+    response = @client.get('/1/help/test.json')
+    response.should_not be_nil
+    response.should == "ok"
+  end
+  
+  it 'should have an public post method' do
+    (@client.public_methods.include? :post).should be_true
+  end
+  
+  it "should post and delete a status" do
+    response = @client.post("/1/statuses/update.json", {:status => 'test status'})
+    response.should_not be_nil
+    destroy_response = @client.post("/1/statuses/destroy/#{response['id']}.json")
+    destroy_response.should_not be_nil
+  end
+  
+end

data/spec/config/config.yml.sample

@@ -0,0 +1,4 @@
+# copy this file and rename it to config.yml
+
+oauth_key: {your oauth key}
+oauth_secret: {your oauth secret}

data/spec/config/test.yml.sample

@@ -0,0 +1,4 @@
+# copy this file and rename it to test.yml
+
+user: {your username}
+password: {your password}

data/spec/spec_helper.rb

@@ -1,14 +1,12 @@
+require 'capybara'
+require 'akephalos'
 require 'twiauth'
 require 'yaml'
-require 'json'
 
-def pull_config
-  yml_config = YAML.load_file(File.dirname(__FILE__) + "/config.yml")
-  yml_config.each do |key, value|
-    instance_variable_set("@#{key}", value)
+RSpec.configure do |config|
+  config.before(:all) do
+    path = File.dirname(__FILE__)
+    @consumer = YAML::load_file("#{path}/config/config.yml")
+    @test = YAML::load_file("#{path}/config/test.yml")
   end
-end
-
-def parse_json(object)
-  JSON.parser.new(object).parse
 end

data/twiauth.gemspec

@@ -1,61 +1,26 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'twiauth'
 
-Gem::Specification.new do |s|
-  s.name = %q{twiauth}
-  s.version = "0.1.0"
+Gem::Specification.new do |spec|
+  spec.name = "twiauth"
+  spec.version = TwiAuth::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ["Sascha Wessel"]
+  spec.email = "swessel@gr4yweb.de"
+  spec.homepage = "http://github.com/gr4y/twiauth"
+  spec.summary = %Q{a very simple twitter authentication wrapper}
+  spec.description = %Q{simple twitter authentication wrapper}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Sascha Wessel"]
-  s.date = %q{2010-09-12}
-  s.description = %q{simple twitter authentication wrapper}
-  s.email = %q{swessel@gr4yweb.de}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/twiauth.rb",
-     "lib/twiauth/oauth.rb",
-     "lib/twiauth/store.rb",
-     "spec/config.yml.sample",
-     "spec/oauth_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/store_spec.rb",
-     "twiauth.gemspec"
-  ]
-  s.homepage = %q{http://github.com/gr4y/twiauth}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{a very simple twitter authentication wrapper}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/oauth_spec.rb",
-     "spec/store_spec.rb"
-  ]
+  spec.rubyforge_project = "twiauth"
 
-  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_runtime_dependency(%q<oauth>, [">= 0.4.0"])
-      s.add_runtime_dependency(%q<rspec>, ["= 1.3.0"])
-    else
-      s.add_dependency(%q<oauth>, [">= 0.4.0"])
-      s.add_dependency(%q<rspec>, ["= 1.3.0"])
-    end
-  else
-    s.add_dependency(%q<oauth>, [">= 0.4.0"])
-    s.add_dependency(%q<rspec>, ["= 1.3.0"])
-  end
-end
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- {test, spec, features}/*`.split("\n")  
+  spec.require_paths = ["lib"]
 
+  spec.add_dependency "oauth", "~> 0.4.0"
+  spec.add_dependency "yajl-ruby", "~> 0.8.2"
+  spec.add_dependency "rspec", "~> 2.5.0"
+  spec.add_development_dependency "capybara", "~> 0.4.1"
+  spec.add_development_dependency "akephalos", "~> 0.2.5"
+  # see http://www.rubygems.org/read/chapter/20 for additional settings
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: twiauth
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  prerelease: 6
+  version: 1.0.0.rc1
 platform: ruby
 authors: 
 - Sascha Wessel
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-12 00:00:00 +02:00
+date: 2011-04-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,60 +19,84 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 0
         version: 0.4.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: yajl-ruby
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+        version: 0.8.2
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.1
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: akephalos
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.5
+  type: :development
+  version_requirements: *id005
 description: simple twitter authentication wrapper
 email: swessel@gr4yweb.de
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/twiauth.rb
-- lib/twiauth/oauth.rb
-- lib/twiauth/store.rb
-- spec/config.yml.sample
-- spec/oauth_spec.rb
+- lib/twiauth/client.rb
+- spec/client_spec.rb
+- spec/config/config.yml.sample
+- spec/config/test.yml.sample
 - spec/spec_helper.rb
-- spec/store_spec.rb
 - twiauth.gemspec
 has_rdoc: true
 homepage: http://github.com/gr4y/twiauth
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -84,25 +104,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+      version: 1.3.1
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: twiauth
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: a very simple twitter authentication wrapper
-test_files: 
-- spec/spec_helper.rb
-- spec/oauth_spec.rb
-- spec/store_spec.rb
+test_files: []
+

data/lib/twiauth/oauth.rb

@@ -1,67 +0,0 @@
-module TwiAuth
-  # oauth communication wrapper
-  class OAuth
-    TWITTER_OAUTH_SPEC = {
-            :site => 'https://api.twitter.com',
-            :request_token_path => '/oauth/request_token',
-            :access_token_path => '/oauth/access_token',
-            :authorize_path => '/oauth/authorize'
-    }
-
-    # key for access token
-    ACCESS_TOKEN = 'ACCESS_TOKEN'
-
-    public
-    def initialize(key, secret)
-      @store = TwiAuth::Store.new
-      @oauth_consumer = ::OAuth::Consumer.new(key, secret, TWITTER_OAUTH_SPEC)
-      get_access_token
-    end
-
-    def get(path)
-      @access_token.get(path)
-    end
-
-    def post(path, body = nil)
-      @access_token.post(path, body)
-    end
-
-    def drop_access_token
-      @store.delete(ACCESS_TOKEN)
-    end
-
-    private
-    def get_request_token
-      @oauth_consumer.get_request_token
-    end
-
-    def get_access_token
-      pull_access_token
-      if @access_token.nil?
-        get_initial_access_token
-      end
-    end
-
-    def get_initial_access_token
-      request_token = get_request_token
-      puts "point your browser to \"#{request_token.authorize_url}\" and enter the pin: "
-      pin = STDIN.readline.chomp!
-
-      if pin.nil? || pin.empty?
-        raise Error
-      end
-
-      @access_token = request_token.get_access_token(:oauth_verifier => pin)
-      persist_access_token
-    end
-
-    def pull_access_token
-      @access_token = @store.get(ACCESS_TOKEN)
-    end
-
-    def persist_access_token
-      @store.put(ACCESS_TOKEN,@access_token)
-    end
-
-  end
-end

data/lib/twiauth/store.rb

@@ -1,35 +0,0 @@
-require 'pstore'
-
-module TwiAuth
-  # A simple key value store using PStore, provided by ruby
-  class Store
-    # Filename for pstore data file
-    DATA_FILE = "data.pstore"
-    # :nodoc:
-    def initialize
-      @store = PStore.new("#{PATH}#{DATA_FILE}")
-    end
-
-    # put a key with value
-    def put(key, value)
-      @store.transaction do
-        @store[key] = value
-      end
-    end
-
-    # get the value of the key 
-    def get(key)
-      @store.transaction do
-        @value = @store[key]
-      end
-      @value
-    end
-
-    # delete a key 
-    def delete(key)
-      @store.transaction do
-        @store.delete(key)
-      end
-    end
-  end
-end

data/spec/config.yml.sample

@@ -1,2 +0,0 @@
-oauth_key: {your oauth key}
-oauth_secret: {your oauth secret}

data/spec/oauth_spec.rb

@@ -1,24 +0,0 @@
-require 'spec_helper'
-
-describe TwiAuth::OAuth do
-
-  before :all do
-    pull_config
-    @oauth = TwiAuth::OAuth.new(@oauth_key, @oauth_secret)
-  end
-
-  it "should be not nil" do
-    @oauth.should_not be_nil
-  end
-
-  it "should get an ok" do
-    @oauth.get("/1/help/test.json").eql?("ok")
-  end
-
-  it "should post and delete a status" do
-    response = @oauth.post("/1/statuses/update.json", {:status => 'test status'})
-    json = parse_json(response.body)
-    @oauth.get("/1/statuses/destroy/#{json['id']}.json")
-  end
-
-end

data/spec/store_spec.rb

@@ -1,22 +0,0 @@
-require 'spec_helper'
-
-describe TwiAuth::Store do
-
-  before :all do
-    @store = TwiAuth::Store.new
-  end
-
-  it "should store some data" do
-    @store.put("test", "test-value")
-  end
-
-  it "should return some data" do
-    @store.get("test").should.eql?("test-value")
-  end
-
-  it "should delete some data" do
-    @store.delete("test")
-    @store.get("test").should be_nil
-  end
-
-end