twurl 0.9.1 → 0.9.6

data/lib/twurl/oauth_client.rb

@@ -9,15 +9,27 @@ module Twurl
       end
 
       def load_from_options(options)
-        if rcfile.has_oauth_profile_for_username_with_consumer_key?(options.username, options.consumer_key)
+        if options.command == 'request' && has_oauth_options?(options)
+          load_new_client_from_oauth_options(options)
+        elsif options.command == 'request' && options.app_only && options.consumer_key
+          load_client_for_non_profile_app_only_auth(options)
+        elsif rcfile.has_oauth_profile_for_username_with_consumer_key?(options.username, options.consumer_key)
           load_client_for_username_and_consumer_key(options.username, options.consumer_key)
-        elsif options.username || (options.command == 'authorize')
+        elsif options.username
+          load_client_for_username(options.username)
+        elsif options.command == 'authorize' && options.app_only
+          load_client_for_app_only_auth(options, options.consumer_key)
+        elsif options.command == 'authorize'
           load_new_client_from_options(options)
         else
-          load_default_client
+          load_default_client(options)
         end
       end
 
+      def has_oauth_options?(options)
+        (options.consumer_key && options.consumer_secret && options.access_token && options.token_secret) ? true : false
+      end
+
       def load_client_for_username_and_consumer_key(username, consumer_key)
         user_profiles = rcfile[username]
         if user_profiles && attributes = user_profiles[consumer_key]
@@ -40,21 +52,63 @@ module Twurl
       end
 
       def load_new_client_from_options(options)
-        new(options.oauth_client_options.merge('password' => options.password))
+        new(options.oauth_client_options)
+      end
+
+      def load_new_client_from_oauth_options(options)
+        new(options.oauth_client_options.merge(
+            'token' => options.access_token,
+            'secret' => options.token_secret
+          )
+        )
+      end
+
+      def load_client_for_app_only_auth(options, consumer_key)
+        if options.command == 'authorize'
+          AppOnlyOAuthClient.new(options)
+        else
+          AppOnlyOAuthClient.new(
+            options.oauth_client_options.merge(
+              'bearer_token' => rcfile.bearer_tokens.to_hash[consumer_key]
+            )
+          )
+        end
       end
 
-      def load_default_client
-        raise Exception, "You must authorize first" unless rcfile.default_profile
-        load_client_for_username_and_consumer_key(*rcfile.default_profile)
+      def load_client_for_non_profile_app_only_auth(options)
+        AppOnlyOAuthClient.new(
+          options.oauth_client_options.merge(
+            'bearer_token' => rcfile.bearer_tokens.to_hash[options.consumer_key]
+          )
+        )
+      end
+
+      def load_default_client(options)
+        return if options.command == 'bearer_tokens'
+
+        exception_message = "You must authorize first."
+        app_only_exception_message = "To use --bearer option, you need to authorize (OAuth1.0a) and create at least one user profile (~/.twurlrc):\n\n" \
+                                     "twurl authorize -c key -s secret\n" \
+                                     "\nor, you can specify issued token's consumer_key directly:\n" \
+                                     "(to see your issued tokens: 'twurl bearer_tokens')\n\n" \
+                                     "twurl --bearer -c key '/path/to/api'"
+
+        raise Exception, "#{options.app_only ? app_only_exception_message : exception_message}" unless rcfile.default_profile
+        if options.app_only
+            raise Exception, "No available bearer token found for consumer_key:#{rcfile.default_profile_consumer_key}" \
+              unless rcfile.has_bearer_token_for_consumer_key?(rcfile.default_profile_consumer_key)
+            load_client_for_app_only_auth(options, rcfile.default_profile_consumer_key)
+        else
+          load_client_for_username_and_consumer_key(*rcfile.default_profile)
+        end
       end
     end
 
     OAUTH_CLIENT_OPTIONS = %w[username consumer_key consumer_secret token secret]
     attr_reader *OAUTH_CLIENT_OPTIONS
-    attr_reader :username, :password
+    attr_reader :username
     def initialize(options = {})
       @username        = options['username']
-      @password        = options['password']
       @consumer_key    = options['consumer_key']
       @consumer_secret = options['consumer_secret']
       @token           = options['token']
@@ -72,13 +126,14 @@ module Twurl
         :copy => Net::HTTP::Copy
       }
 
-    def perform_request_from_options(options, &block)
+    def build_request_from_options(options, &block)
       request_class = METHODS.fetch(options.request_method.to_sym)
       request = request_class.new(options.path, options.headers)
 
       if options.upload && options.upload['file'].count > 0
         boundary = "00Twurl" + rand(1000000000000000000).to_s + "lruwT99"
         multipart_body = []
+        file_field = options.upload['filefield'] ? options.upload['filefield'] : 'media[]'
 
         options.data.each {|key, value|
           multipart_body << "--#{boundary}\r\n"
@@ -90,34 +145,53 @@ module Twurl
 
         options.upload['file'].each {|filename|
           multipart_body << "--#{boundary}\r\n"
-          multipart_body << "Content-Disposition: form-data; name=\"#{options.upload['filefield']}\"; filename=\"#{File.basename(filename)}\"\r\n"
+          multipart_body << "Content-Disposition: form-data; name=\"#{file_field}\"; filename=\"#{File.basename(filename)}\"\r\n"
           multipart_body << "Content-Type: application/octet-stream\r\n"
           multipart_body << "Content-Transfer-Encoding: base64\r\n" if options.upload['base64']
           multipart_body << "\r\n"
 
           if options.upload['base64']
-            enc = Base64.encode64(File.read(filename))
+            enc = Base64.encode64(File.binread(filename))
             multipart_body << enc
-          else 
-            multipart_body << File.read(filename)
+          else
+            multipart_body << File.binread(filename)
           end
         }
 
         multipart_body << "\r\n--#{boundary}--\r\n"
-        
+
         request.body = multipart_body.join
-        request['Content-Type'] = "multipart/form-data, boundary=\"#{boundary}\""
+        request.content_type = "multipart/form-data, boundary=\"#{boundary}\""
+      elsif request.content_type && options.data
+        request.body = options.data.keys.first
       elsif options.data
-        request.set_form_data(options.data)
+        request.content_type = "application/x-www-form-urlencoded"
+        if options.data.length == 1 && options.data.values.first == nil
+          request.body = options.data.keys.first
+        else
+          request.body = options.data.map do |key, value|
+            "#{key}=#{CGI.escape value}"
+          end.join("&")
+        end
       end
+      request
+    end
 
+    def perform_request_from_options(options, &block)
+      request = build_request_from_options(options)
       request.oauth!(consumer.http, consumer, access_token)
+      request['user-agent'] = user_agent
       consumer.http.request(request, &block)
     end
 
+    def user_agent
+      "twurl version: #{Version} " \
+      "platform: #{RUBY_ENGINE} #{RUBY_VERSION} (#{RUBY_PLATFORM})"
+    end
+
     def exchange_credentials_for_access_token
       response = begin
-        consumer.token_request(:post, consumer.access_token_path, nil, {}, client_auth_parameters)
+        consumer.token_request(:post, consumer.access_token_path, nil, {})
       rescue OAuth::Unauthorized
         perform_pin_authorize_workflow
       end
@@ -125,14 +199,10 @@ module Twurl
       @secret  = response[:oauth_token_secret]
     end
 
-    def client_auth_parameters
-      {'x_auth_username' => username, 'x_auth_password' => password, 'x_auth_mode' => 'client_auth'}
-    end
-
     def perform_pin_authorize_workflow
       @request_token = consumer.get_request_token
       CLI.puts("Go to #{generate_authorize_url} and paste in the supplied PIN")
-      pin = gets
+      pin = STDIN.gets
       access_token = @request_token.get_access_token(:oauth_verifier => pin.chomp)
       {:oauth_token => access_token.token, :oauth_token_secret => access_token.secret}
     end
@@ -188,6 +258,10 @@ module Twurl
 
     def configure_http!
       consumer.http.set_debug_output(Twurl.options.debug_output_io) if Twurl.options.trace
+      consumer.http.read_timeout = consumer.http.open_timeout = Twurl.options.timeout || 60
+      consumer.http.open_timeout = Twurl.options.connection_timeout if Twurl.options.connection_timeout
+      # Only override if Net::HTTP support max_retries (since Ruby >= 2.5)
+      consumer.http.max_retries = 0 if consumer.http.respond_to?(:max_retries=)
       if Twurl.options.ssl?
         consumer.http.use_ssl     = true
         consumer.http.verify_mode = OpenSSL::SSL::VERIFY_NONE

data/lib/twurl/rcfile.rb

@@ -52,6 +52,11 @@ module Twurl
       configuration['default_profile']
     end
 
+    def default_profile_consumer_key
+      username, consumer_key = configuration['default_profile']
+      consumer_key
+    end
+
     def default_profile=(profile)
       configuration['default_profile'] = [profile.username, profile.consumer_key]
     end
@@ -67,7 +72,17 @@ module Twurl
     end
 
     def aliases
-      data['aliases']
+      data['aliases'] ||= {}
+    end
+
+    def bearer_token(consumer_key, bearer_token)
+      data['bearer_tokens'] ||= {}
+      data['bearer_tokens'][consumer_key] = bearer_token
+      save
+    end
+
+    def bearer_tokens
+      data['bearer_tokens']
     end
 
     def alias_from_options(options)
@@ -87,6 +102,10 @@ module Twurl
       !user_profiles.nil? && !user_profiles[consumer_key].nil?
     end
 
+    def has_bearer_token_for_consumer_key?(consumer_key)
+      bearer_tokens.nil? ? false : bearer_tokens.to_hash.has_key?(consumer_key)
+    end
+
     def <<(oauth_client)
       client_from_file = self[oauth_client.username] || {}
       client_from_file[oauth_client.consumer_key] = oauth_client.to_hash

data/lib/twurl/request_controller.rb

@@ -1,20 +1,41 @@
 module Twurl
   class RequestController < AbstractCommandController
-    NO_URI_MESSAGE = "No URI specified"
+    NO_URI_MESSAGE       = 'No URI specified'
+    INVALID_URI_MESSAGE  = 'Invalid URI detected'
+    READ_TIMEOUT_MESSAGE = 'A timeout occurred (Net::ReadTimeout). ' \
+                           'Please try again or increase the value using --timeout option.'
+    OPEN_TIMEOUT_MESSAGE = 'A timeout occurred (Net::OpenTimeout). ' \
+                           'Please try again or increase the value using --connection-timeout option.'
     def dispatch
       if client.needs_to_authorize?
         raise Exception, "You need to authorize first."
       end
       options.path ||= OAuthClient.rcfile.alias_from_options(options)
+      raise Exception, NO_URI_MESSAGE if options.path.empty?
       perform_request
     end
 
     def perform_request
       client.perform_request_from_options(options) { |response|
-        response.read_body { |chunk| CLI.print chunk }
+        response.read_body { |body|
+          CLI.print options.json_format ? JsonFormatter.format(body) : body
+        }
       }
     rescue URI::InvalidURIError
-      CLI.puts NO_URI_MESSAGE
+      CLI.puts INVALID_URI_MESSAGE
+    rescue Net::ReadTimeout
+      CLI.puts READ_TIMEOUT_MESSAGE
+    rescue Net::OpenTimeout
+      CLI.puts OPEN_TIMEOUT_MESSAGE
+    end
+  end
+
+  class JsonFormatter
+    def self.format(string)
+      json = JSON.parse(string)
+      (json.is_a?(Array) || json.is_a?(Hash)) ? JSON.pretty_generate(json) : string
+    rescue JSON::ParserError, TypeError
+      string
     end
   end
 end

data/lib/twurl/version.rb

@@ -2,13 +2,13 @@ module Twurl
   class Version
     MAJOR = 0 unless defined? Twurl::Version::MAJOR
     MINOR = 9 unless defined? Twurl::Version::MINOR
-    PATCH = 1 unless defined? Twurl::Version::PATCH
-    BETA = nil unless defined? Twurl::Version::BETA # Time.now.to_i.to_s
+    PATCH = 6 unless defined? Twurl::Version::PATCH
+    PRE = nil unless defined? Twurl::Version::PRE # Time.now.to_i.to_s
 
     class << self
       # @return [String]
       def to_s
-        [MAJOR, MINOR, PATCH, BETA].compact.join('.')
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
       end
     end
   end

data/twurl.gemspec

@@ -5,21 +5,18 @@ require 'twurl/version'
 
 Gem::Specification.new do |spec|
   spec.add_dependency 'oauth', '~> 0.4'
-  spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.authors = ["Marcel Molina", "Erik Michaels-Ober"]
+  spec.authors = ["Marcel Molina", "Erik Michaels-Ober", "@TwitterDev team"]
   spec.description = %q{Curl for the Twitter API}
-  spec.email = ['marcel@twitter.com']
-  spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  spec.extra_rdoc_files = %w(COPYING INSTALL README)
-  spec.files = `git ls-files`.split("\n")
-  spec.homepage = 'http://github.com/marcel/twurl'
+  spec.bindir = 'bin'
+  spec.executables << 'twurl'
+  spec.extra_rdoc_files = Dir["*.md", "LICENSE"]
+  spec.files = Dir["*.md", "LICENSE", "twurl.gemspec", "bin/*", "lib/**/*"]
+  spec.homepage = 'http://github.com/twitter/twurl' 
   spec.licenses = ['MIT']
   spec.name = 'twurl'
-  spec.rdoc_options = ['--title', 'twurl -- OAuth-enabled curl for the Twitter API', '--main', 'README', '--line-numbers', '--inline-source']
+  spec.rdoc_options = ['--title', 'twurl -- OAuth-enabled curl for the Twitter API', '--main', 'README.md', '--line-numbers', '--inline-source']
   spec.require_paths = ['lib']
-  spec.required_rubygems_version = '>= 1.3.5'
-  spec.rubyforge_project = 'twurl'
+  spec.required_ruby_version = '>= 2.4.0'
   spec.summary = spec.description
-  spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   spec.version = Twurl::Version
 end

metadata

@@ -1,73 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: twurl
 version: !ruby/object:Gem::Version
-  version: 0.9.1
-  prerelease: 
+  version: 0.9.6
 platform: ruby
 authors:
 - Marcel Molina
 - Erik Michaels-Ober
-autorequire: 
+- "@TwitterDev team"
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Curl for the Twitter API
 email:
-- marcel@twitter.com
 executables:
 - twurl
 extensions: []
 extra_rdoc_files:
-- COPYING
-- INSTALL
-- README
+- CODE_OF_CONDUCT.md
+- INSTALL.md
+- README.md
+- CONTRIBUTING.md
+- LICENSE
 files:
-- .gemtest
-- .gitignore
-- .travis.yml
-- COPYING
-- Gemfile
-- INSTALL
-- README
-- Rakefile
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- INSTALL.md
+- LICENSE
+- README.md
 - bin/twurl
 - lib/twurl.rb
 - lib/twurl/abstract_command_controller.rb
 - lib/twurl/account_information_controller.rb
 - lib/twurl/aliases_controller.rb
+- lib/twurl/app_only_oauth_client.rb
+- lib/twurl/app_only_token_information_controller.rb
 - lib/twurl/authorization_controller.rb
 - lib/twurl/cli.rb
 - lib/twurl/configuration_controller.rb
@@ -75,57 +57,34 @@ files:
 - lib/twurl/rcfile.rb
 - lib/twurl/request_controller.rb
 - lib/twurl/version.rb
-- test/account_information_controller_test.rb
-- test/alias_controller_test.rb
-- test/authorization_controller_test.rb
-- test/cli_options_test.rb
-- test/cli_test.rb
-- test/configuration_controller_test.rb
-- test/oauth_client_test.rb
-- test/rcfile_test.rb
-- test/request_controller_test.rb
-- test/test_helper.rb
 - twurl.gemspec
-homepage: http://github.com/marcel/twurl
+homepage: http://github.com/twitter/twurl
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options:
-- --title
+- "--title"
 - twurl -- OAuth-enabled curl for the Twitter API
-- --main
-- README
-- --line-numbers
-- --inline-source
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.5
+      version: '0'
 requirements: []
-rubyforge_project: twurl
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
 summary: Curl for the Twitter API
-test_files:
-- test/account_information_controller_test.rb
-- test/alias_controller_test.rb
-- test/authorization_controller_test.rb
-- test/cli_options_test.rb
-- test/cli_test.rb
-- test/configuration_controller_test.rb
-- test/oauth_client_test.rb
-- test/rcfile_test.rb
-- test/request_controller_test.rb
-- test/test_helper.rb
-has_rdoc: 
+test_files: []