twimock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98d87b06d405b5e1b62b1e556b0364db89fd791f
+  data.tar.gz: 51a1cc2ac6c7bf7bc616330947265a52f3736462
+SHA512:
+  metadata.gz: 1bada1bcbe144100f5d8358303b6e9214cface5cd33052e5f5f4f0f8154a06ac45b24b606b658dc09f2bc38748ef4f808b186d5b6c8242e37a11e7b562568d29
+  data.tar.gz: 46af02913e36302f7eb310e1eda72711fa7857bedd0dc7cce99f72e5dc9e3a2c0038ac101d96975272ea588f562b17910645393a5da4871d14533eb813904fd6

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ogawatti
+
+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,125 @@
+[![Gem Version](https://badge.fury.io/rb/twimock.svg)](http://badge.fury.io/rb/twimock)
+[![Build Status](https://travis-ci.org/ogawatti/twimock.svg?branch=master)](https://travis-ci.org/ogawatti/twimock)
+[![Coverage Status](https://coveralls.io/repos/ogawatti/twimock/badge.png?branch=master)](https://coveralls.io/r/ogawatti/twimock?branch=master)
+[<img src="https://gemnasium.com/ogawatti/twimock.png" />](https://gemnasium.com/ogawatti/twimock)
+[![Code Climate](https://codeclimate.com/github/ogawatti/twimock.png)](https://codeclimate.com/github/ogawatti/twimock)
+
+# Twimock
+
+This gem is used to mock the communication part of the twitter api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'twimock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twimock
+
+## Usage
+
+### For Rails App Settings (config/initializers/twimock.rb)
+
+    # Create Twimock Application & User
+    application = Twimock::Application.create!
+    user        = Twimock::User.create!
+
+    # Associate App and User
+    user.generate_access_token(app.id)
+
+    # Twimock Setting
+    Twimock::Config.host         = 'example.com'
+    Twimock::Config.port         = 3000
+    Twimock::Config.callback_url = '/users/auth/twitter/callback'
+
+    # Enable Twimock
+    Twimock::API.on
+    Twimock::OmniAuthTwitter.on
+
+    # Add Rack Middleware for twimock
+    [ Twimock::API::OAuth::Authenticate, Twimock::API::Intent::Sessions ].each do |middleware|
+      Rails.application.config.middleware.use middleware
+    end
+
+### Create Apps and Users at once by yaml file
+
+    require 'twimock'
+
+    filename = File.expand_path('../test_users.yml', __FILE__)
+    Twimock::Config.load_users(filename)
+
+    Twimock::Application.find_by_id(1).api_key  #=> avb0vlu767yhu37hti5qq9hcc
+    Twimock::User.find_by_id(1).name            #=> testuser01
+
+yaml file see below.
+
+    ---
+    - :id: 1
+      :api_key: avb0vlu767yhu37hti5qq9hcc
+      :api_secret: e85vl7fc4susiyjjp0pncz0hf2xtf3vm29gj7hhp2ktv28wunl
+      :users:
+      - :id: 1
+        :name: testuser01
+        :password: r3xkhy64w
+        :access_token: 6697725737-9ntcnith1wq7zgphnisxu6bqybl019bms05t8l9
+        :access_token_secret: 22ogzdkn5kqtlihr3u5vwplrlh8noie61pr6ndeangrpt
+        :application_id: 1
+      - :id: 2
+        :name: testuser02
+        :password: 5ush05lp0
+        :access_token: 6891305263-xpvu78zd1p76s3cp6jwrudgb0g0sffxe9hp7mdj
+        :access_token_secret: or1xkqs96tim8n7vhc77yxo2i6ed9a6bmhru0zozjao80
+        :application_id: 1
+    - :id: 2
+      :api_key: w6cb9sj17fyf5g1rr4fl5ignp
+      :api_secret: 2vrdpujwvl3421qatn8qah9ishpia9khq7mprnkfx49mldo0k6
+      :users:
+      - :id: 3
+        :name: testuser03
+        :password: ylgi4lth
+        :access_token: 6932630251-1sshumnflh0abshkgaf2scxa6l02cr8tyi2kt00
+        :access_token_secret: txncllipm1wl0g21wvtc750lqz2dleu6e0lqg62vt7eam
+        :application_id: 2
+
+### User Model
+
+    require 'twimock'
+
+    # Create
+    user = Twimock::User.new
+    user.name = "twimock_test_user"
+    user.save!
+
+    user = Twimock::User.new(name: "hoge", password: "fuga")
+    user.name      #=> "hoge"
+    user.save!
+
+    user = Twimock::User.create!(name: "hogehoge", password: "fugafuga")
+    user.name      #=> "hogehoge"
+    user.password  #=> "fugafuga"
+
+    # Find
+    Twimock::User.find_by_id(1)
+    Twimock::User.find_by_name("testuser01")
+    Twimock::User.where(name: "testuser02")
+    Twimock::User.all
+    Twimock::User.first
+    Twimock::User.last
+
+    # Delete
+    user = User.last
+    user.destroy
+
+## Contributing
+
+1. Fork it
+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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/twimock/access_token.rb

@@ -0,0 +1,31 @@
+require 'faker'
+require 'twimock/database/table'
+
+module Twimock
+  class AccessToken < Database::Table
+    TABLE_NAME = :access_tokens
+    COLUMN_NAMES = [:id, :string, :secret, :application_id, :user_id, :created_at]
+
+    def initialize(options={})
+      opts = Hashie::Mash.new(options)
+      id = opts.id.to_i
+      @id             = id if id > 0
+      app_id = opts.application_id.to_i
+      @application_id = app_id if app_id > 0
+      user_id = opts.user_id.to_i
+      @user_id        = user_id if user_id > 0
+
+      @string = generate_string(opts.string)
+      @secret = opts.secret || Faker::Lorem.characters(45)
+      @created_at     = opts.created_at
+    end
+
+    private
+
+    def generate_string(string=nil)
+      return string if string
+      return "#{@user_id}-#{Faker::Lorem.characters(39)}" if @user_id
+      return Faker::Lorem.characters(50)
+    end
+  end
+end

data/lib/twimock/api/account/verify_credentials.rb

@@ -0,0 +1,40 @@
+require 'twimock/api/oauth'
+require 'twimock/user'
+
+module Twimock
+  module API
+    # OAuth 1.1, OAuth Echo で利用するAPI
+    # ユーザ情報を取得する
+    module Account
+      class VerifyCredentials < OAuth
+        METHOD = "GET"
+        PATH   = "/1.1/account/verify_credentials.json"
+        AUTHORIZATION_REGEXP = /OAuth oauth_consumer_key=\"(.*)\", oauth_nonce=\"(.*)\", oauth_signature=\"(.*)\", oauth_signature_method=\"(.*)\", oauth_timestamp=\"(.*)\", oauth_token=\"(.*)\", oauth_version=\"(.*)\".*/
+
+        def call(env)
+          return super unless called?(env)
+
+          begin
+            authorization_header = env["authorization"] || env["HTTP_AUTHORIZATION"]
+            oauth = parse_authorization_header(authorization_header)
+
+            raise Twimock::Errors::InvalidConsumerKey.new if !validate_consumer_key(oauth.consumer_key)
+            application = Twimock::Application.find_by_api_key(oauth.consumer_key)
+            raise Twimock::Errors::InvalidAccessToken.new if !validate_access_token(oauth.token, application.id)
+            access_token = Twimock::AccessToken.find_by_string(oauth.token)
+            user = Twimock::User.find_by_id(access_token.user_id)
+          rescue Twimock::Errors::InvalidAccessToken, Twimock::Errors::InvalidConsumerKey => @error
+            return unauthorized
+          rescue => @error
+            return internal_server_error
+          end
+
+          status = '200 OK'
+          body = user.info.to_json
+          header = { "Content-Length" => body.bytesize.to_s }
+          [ status, header, [ body ] ]
+        end
+      end
+    end
+  end
+end

data/lib/twimock/api/application.rb

@@ -0,0 +1,29 @@
+require 'excon'
+
+module Twimock
+  module API
+    # Rack Application
+    # Net::HTTP は ShamRack で偽装されるため, Excon (Socket) で通信する
+    class Application
+      def call(env)
+        request(env)
+      end
+
+      private
+
+      def request(env)
+        rackreq = Rack::Request.new(env)
+        connection = Excon.new(rackreq.url)
+
+        options = {}
+        options[:method]  = rackreq.request_method
+        options[:path]    = rackreq.path
+        options[:headers] = rackreq.env.select{|k,v| k !~ /^rack\./}
+        options[:body]    = rackreq.body.read
+
+        res = connection.request(options)
+        [ res.status, res.headers, [ res.body ] ]
+      end
+    end
+  end
+end

data/lib/twimock/api/intent/sessions.rb

@@ -0,0 +1,60 @@
+require 'uri'
+require 'erb'
+require 'json'
+require 'addressable/uri'
+require 'twimock/errors'
+
+module Twimock
+  module API
+    # POST https://twitter.com/intent/sessions
+    #   body: { 'session[username_or_email]' => "xxx", 'session[password]' => "xxx", oauth_token: "xxx" }
+    module Intent
+      class Sessions < OAuth
+        METHOD = "POST"
+        PATH   = "/intent/sessions"
+
+        def call(env)
+          return super unless called?(env)
+          begin
+            request = Rack::Request.new(env)
+            body = query_string_to_hash(request.body.read)
+            @oauth_token       = body.oauth_token
+            @username_or_email = body["session[username_or_email]"]
+            @password          = body["session[password]"]
+
+            if !validate_request_token(@oauth_token)
+              raise Twimock::Errors::InvalidRequestToken.new
+            elsif !(user = Twimock::User.find_by_tiwtter_id_or_email(@username_or_email))
+              raise Twimock::Errors::InvalidUsernameOrEmail.new 
+            elsif @password.blank? || @password != user.password
+              raise Twimock::Errors::InvalidPassword.new 
+            end
+            request_token = Twimock::RequestToken.find_by_string(@oauth_token)
+            request_token.user_id = user.id
+            request_token.save!
+
+            uri = Addressable::URI.new
+            uri.query_values = { oauth_token: request_token.string,
+                                 oauth_verifier: request_token.verifier }
+            callback_url = Twimock::Config.callback_url + "?" + uri.query
+
+            status = 302
+            body   = ""
+            header = { "Content-Length" => body.bytesize.to_s,
+                       "Location" => callback_url }
+            [ status, header, [ body ] ]
+          rescue Twimock::Errors::InvalidUsernameOrEmail, Twimock::Errors::InvalidPassword => @error
+            response = unauthorized
+            response[0] = 302
+            response[1].merge!( {"Location" => "/oauth/authenticate?oauth_token=#{@oauth_token}" })
+            response
+          rescue Twimock::Errors::InvalidRequestToken => @error
+            return unauthorized
+          rescue => @error
+            internal_server_error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twimock/api/oauth/access_token.rb

@@ -0,0 +1,65 @@
+require 'twimock/api/oauth'
+require 'twimock/user'
+
+module Twimock
+  module API
+    class OAuth
+    # OAuth 1.1 で利用するAPI
+    # Access Token を取得する
+      class AccessToken < OAuth
+        METHOD = "POST"
+        PATH   = "/oauth/access_token"
+        AUTHORIZATION_REGEXP = /OAuth oauth_body_hash=\"(.*)\", oauth_consumer_key=\"(.*)\", oauth_nonce=\"(.*)\", oauth_signature=\"(.*)\", oauth_signature_method=\"(.*)\", oauth_timestamp=\"(.*)\", oauth_token=\"(.*)\", oauth_verifier=\"(.*)\", oauth_version=\"(.*)\"/
+
+        def call(env)
+          return super unless called?(env)
+          begin
+            authorization_header = env["authorization"] || env["HTTP_AUTHORIZATION"]
+            oauth = parse_authorization_header(authorization_header)
+            consumer_key  = oauth.consumer_key
+            request_token = oauth.token
+
+            raise Twimock::Errors::InvalidConsumerKey.new if !validate_consumer_key(consumer_key)
+            application = Twimock::Application.find_by_api_key(consumer_key)
+            if !validate_request_token(request_token, application.id)
+              raise Twimock::Errors::InvalidRequestToken.new 
+            end
+            request_token = Twimock::RequestToken.find_by_string(request_token)
+            user = Twimock::User.find_by_id(request_token.user_id)
+            access_tokens = Twimock::AccessToken.where(user_id: user.id)
+            unless access_token = access_tokens.find{|at| at.application_id == application.id }
+              access_token = user.generate_access_token(application.id)
+            end
+          rescue Twimock::Errors::InvalidConsumerKey, Twimock::Errors::InvalidRequestToken => @error
+            return unauthorized
+          rescue => @error
+            return internal_server_error
+          end
+
+          status = "200 OK"
+          params = {
+            oauth_token:        access_token.string,
+            oauth_token_secret: access_token.secret,
+            user_id:            user.id,
+            screen_name:        user.twitter_id
+          }
+          body   = params.inject([]){|a, (k, v)| a << "#{k}=#{v}"}.join('&')
+          header = { "Content-Length" => body.bytesize.to_s }
+
+          [ status, header, [ body ] ]
+        end
+
+        private
+
+        def validate_request_token(request_token, application_id)
+          return false unless super(request_token)
+
+          request_token = Twimock::RequestToken.find_by_string(request_token)
+          return false unless request_token.application_id == application_id
+          return false unless User.find_by_id(request_token.user_id)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/twimock/api/oauth/authenticate.rb

@@ -0,0 +1,51 @@
+require 'uri'
+require 'erb'
+
+module Twimock
+  module API
+    # OAuthでブラウザ認証するAPI
+    # GET http://api.twimock.com/authenticate?oauth_token=xxx
+    class OAuth
+      class Authenticate < OAuth
+        METHOD = "GET"
+        PATH   = "/oauth/authenticate"
+        VIEW_DIRECTORY = File.expand_path("../../../../../view", __FILE__)
+        VIEW_FILE_NAME = "authenticate.html.erb"
+
+        def call(env)
+          return super unless called?(env)
+          begin
+            request = Rack::Request.new(env)
+            @oauth_token = request.params["oauth_token"]
+
+            if !validate_request_token(@oauth_token)
+              raise Twimock::Errors::InvalidRequestToken.new
+            end
+
+            status = 200
+            body   = Twimock::API::OAuth::Authenticate.view(@oauth_token)
+            header = { "Content-Length" => body.bytesize.to_s }
+            [ status, header, [ body ] ]
+          rescue Twimock::Errors::InvalidRequestToken => @error
+            unauthorized
+          rescue => @error
+            internal_server_error
+          end
+        end
+
+        def self.view(oauth_token)
+          @action_url = Twimock::API::Intent::Sessions::PATH
+          @oauth_token = oauth_token
+          erb = ERB.new(File.read(filepath))
+          erb.result(binding)
+        end
+
+        private
+
+        def self.filepath
+          File.join(VIEW_DIRECTORY, VIEW_FILE_NAME)
+        end
+      end
+    end
+  end
+end

data/lib/twimock/api/oauth/request_token.rb

@@ -0,0 +1,49 @@
+require 'twimock/api/oauth'
+require 'twimock/application'
+
+module Twimock
+  module API
+    # Twitter OAuth で利用するAPI
+    # Request Token を発行する
+    class OAuth
+      class RequestToken < OAuth
+        METHOD = "POST"
+        PATH   = "/oauth/request_token"
+        AUTHORIZATION_REGEXP = /OAuth oauth_callback=\"(.*)\", oauth_consumer_key=\"(.*)\", oauth_nonce=\"(.*)\", oauth_signature=\"(.*)\", oauth_signature_method=\"(.*)\", oauth_timestamp=\"(.*)\", oauth_version=\"(.*)\".*/
+
+        def call(env)
+          return super unless called?(env)
+          begin
+            authorization_header = env["authorization"] || env["HTTP_AUTHORIZATION"]
+            oauth = parse_authorization_header(authorization_header)
+            consumer_key = oauth.consumer_key
+
+            raise Twimock::Errors::InvalidConsumerKey.new if !validate_consumer_key(consumer_key)
+            application = Twimock::Application.find_by_api_key(consumer_key)
+          rescue Twimock::Errors::InvalidConsumerKey => @error
+            return unauthorized
+          rescue => @error
+            return internal_server_error
+          end
+
+          request_token = create_request_token(application.id)
+          status = "200 OK"
+          params = { oauth_token:              request_token.string,
+                     oauth_token_secret:       request_token.secret,
+                     oauth_callback_confirmed: true }
+          body   = params.inject([]){|a, (k, v)| a << "#{k}=#{v}"}.join('&')
+          header = { "Content-Length" => body.bytesize.to_s }
+          [ status, header, [ body ] ]
+        end
+
+        private
+
+        def create_request_token(application_id)
+          request_token = Twimock::RequestToken.new(application_id: application_id)
+          request_token.save!
+          request_token
+        end
+      end
+    end
+  end
+end

data/lib/twimock/api/oauth.rb

@@ -0,0 +1,83 @@
+require 'twimock/api/oauth/access_token'
+require 'twimock/api/oauth/request_token'
+require 'twimock/api/oauth/authenticate'
+require 'twimock/api/intent/sessions'
+require 'twimock/api/account/verify_credentials'
+require 'twimock/errors'
+
+module Twimock
+  module API
+    class OAuth
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      end
+
+      private
+
+      def validate_consumer_key(consumer_key)
+        return false if consumer_key.blank?
+        return false unless application = Twimock::Application.find_by_api_key(consumer_key)
+        true
+      end
+
+      def validate_request_token(request_token)
+        return false if request_token.blank?
+        return false unless request_token = Twimock::RequestToken.find_by_string(request_token)
+        return false unless request_token.application_id
+        true
+      end
+
+      def validate_access_token(access_token_string, application_id)
+        return false if access_token_string.blank?
+        return false unless access_token = Twimock::AccessToken.find_by_string(access_token_string)
+        return false unless access_token.application_id
+        return false unless access_token.application_id == application_id
+        true
+      end
+
+      def called?(env)
+        request = Rack::Request.new(env)
+        request.request_method == self.class::METHOD && request.path == self.class::PATH
+      end
+
+      def unauthorized
+        generate_error_response(401)
+      end
+
+      def internal_server_error
+        generate_error_response(500)
+      end
+
+      def parse_authorization_header(authorization_header)
+        authorization = case authorization_header
+        when Array  then authorization_header.first
+        when String then authorization_header
+        else ""
+        end
+
+        oauth = Hashie::Mash.new
+        authorization.scan(/oauth_(\w+)=\"([\w%-.]+)\"/) do |key, value|
+          oauth[key] = value
+        end
+        oauth
+      end
+
+      def query_string_to_hash(query_string)
+        ary = URI.decode(query_string).split("&").inject([]){|a, s| a << s.split("=")}
+        Hashie::Mash.new(Hash[ary])
+      end
+
+      def generate_error_response(status)
+        error_code = @error.class.to_s.split("::").last
+        body   = { error: { code: error_code } }.to_json
+        header = { "Content-Type"   => "application/json; charset=utf-8",
+                   "Content-Length" => body.bytesize.to_s }
+        [ status, header, [ body ] ]
+      end
+    end
+  end
+end

data/lib/twimock/api.rb

@@ -0,0 +1,35 @@
+require 'twimock/api/application'
+require 'twimock/api/oauth'
+require 'sham_rack'
+
+module Twimock
+  module API
+    extend self
+
+    HOSTNAME    = "api.twitter.com"
+    PORT        = 443
+    MIDDLEWARES = [ OAuth::AccessToken, OAuth::RequestToken, Account::VerifyCredentials ]
+
+    def on
+      ShamRack.at(HOSTNAME, PORT){|env| app.call(env) } unless on?
+      true
+    end
+    
+    def off
+      ShamRack.unmount_all
+      true
+    end
+
+    def on?
+      !ShamRack.application_for(HOSTNAME, PORT).nil?
+    end
+
+    # Rack Application
+    def app
+      app = Twimock::API::Application.new
+      MIDDLEWARES.inject(app) do |app, klass|
+        app = klass.new(app)
+      end
+    end
+  end
+end

data/lib/twimock/application.rb

@@ -0,0 +1,21 @@
+require 'faker'
+require 'twimock/database/table'
+require 'twimock/access_token'
+require 'twimock/request_token'
+
+module Twimock
+  class Application < Database::Table
+    TABLE_NAME = :applications
+    COLUMN_NAMES = [:id, :api_key, :api_secret, :created_at]
+    CHILDREN = [ Twimock::AccessToken, Twimock::RequestToken ]
+
+    # WANT : DBに登録済みの値と重複しないようにする(id, api_secret)
+    def initialize(options={})
+      opts = Hashie::Mash.new(options)
+      @id         = ( opts.id.to_i > 0 ) ? opts.id.to_i : Faker::Number.number(10).to_i
+      @api_key        = opts.api_key    || Faker::Lorem.characters(25)
+      @api_secret     = opts.api_secret || Faker::Lorem.characters(50)
+      @created_at = opts.created_at
+    end
+  end
+end