stripe 1.8.1 → 1.8.2

data/.gitignore

@@ -1,2 +1,3 @@
 /stripe-*.gem
+/Gemfile.lock
 .rvmrc

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
 gemfile:
   - gemfiles/default-with-activesupport.gemfile
   - gemfiles/json.gemfile

data/History.txt

@@ -1,3 +1,17 @@
+=== 1.8.2 2013-05-01
+
+* 3 minor enhancement:
+  * Use to_sym instead of type checking for minor performance
+    improvement (github issue #59)
+  * Handle low-memory situations without throwing an exception (github
+    issue #61)
+  * Add an Customer#upcoming_invoice convenience method (github issue
+    #65)
+
+* 1 bugfix:
+  * Allow updating resources without first retrieving them (github
+    issue #60)
+
 === 1.8.1 2013-04-19
 
 * 1 minor enhancement:

data/README.rdoc

@@ -23,6 +23,16 @@ The stripe gem is mirrored on Rubygems, so you should be able to
 install it via <tt>gem install stripe</tt> if desired. We recommend using 
 the https://code.stripe.com mirror so all code is fetched over SSL.
 
+Note that if you are installing via bundler, you should be sure to use the https
+rubygems source in your Gemfile, as any gems fetched over http could potentially be
+comprimised in transit and alter the code of gems fetched securely over https:
+
+  source 'https://code.stripe.com'
+  source 'https://rubygems.org'
+  
+  gem 'rails'
+  gem 'stripe'
+
 == Development
 
 Test cases can be run with: `bundle exec rake test`

data/VERSION

@@ -1 +1 @@
-1.8.1
+1.8.2

data/lib/stripe.rb

@@ -43,163 +43,164 @@ require 'stripe/errors/invalid_request_error'
 require 'stripe/errors/authentication_error'
 
 module Stripe
-  @@ssl_bundle_path = File.join(File.dirname(__FILE__), 'data/ca-certificates.crt')
-  @@api_key = nil
-  @@api_base = 'https://api.stripe.com'
-  @@verify_ssl_certs = true
-  @@api_version = nil
+  @api_base = 'https://api.stripe.com'
 
-  def self.api_url(url='')
-    @@api_base + url
-  end
-
-  def self.api_key=(api_key)
-    @@api_key = api_key
-  end
-
-  def self.api_key
-    @@api_key
-  end
+  @ssl_bundle_path  = File.dirname(__FILE__) + '/data/ca-certificates.crt'
+  @verify_ssl_certs = true
 
-  def self.api_base=(api_base)
-    @@api_base = api_base
+  class << self
+    attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version
   end
 
-  def self.api_base
-    @@api_base
-  end
-
-  def self.verify_ssl_certs=(verify)
-    @@verify_ssl_certs = verify
-  end
-
-  def self.verify_ssl_certs
-    @@verify_ssl_certs
+  def self.api_url(url='')
+    @api_base + url
   end
 
-  def self.api_version=(version)
-    @@api_version = version
-  end
+  def self.request(method, url, api_key, params={}, headers={})
+    unless api_key ||= @api_key
+      raise AuthenticationError.new('No API key provided. ' +
+        'Set your API key using "Stripe.api_key = <API-KEY>". ' +
+        'You can generate API keys from the Stripe web interface. ' +
+        'See https://stripe.com/api for details, or email support@stripe.com ' +
+        'if you have any questions.')
+    end
 
-  def self.api_version
-    @@api_version
-  end
+    if api_key =~ /\s/
+      raise AuthenticationError.new('Your API key is invalid, as it contains ' +
+        'whitespace. (HINT: You can double-check your API key from the ' +
+        'Stripe web interface. See https://stripe.com/api for details, or ' +
+        'email support@stripe.com if you have any questions.)')
+    end
 
-  def self.request(method, url, api_key, params={}, headers={})
-    api_key ||= @@api_key
-    raise AuthenticationError.new('No API key provided.  (HINT: set your API key using "Stripe.api_key = <API-KEY>".  You can generate API keys from the Stripe web interface.  See https://stripe.com/api for details, or email support@stripe.com if you have any questions.)') unless api_key
+    request_opts = { :verify_ssl => false }
 
-    if !verify_ssl_certs
-      unless @no_verify
-        $stderr.puts "WARNING: Running without SSL cert verification.  Execute 'Stripe.verify_ssl_certs = true' to enable verification."
-        @no_verify = true
-      end
-      ssl_opts = { :verify_ssl => false }
-    elsif !Util.file_readable(@@ssl_bundle_path)
-      unless @no_bundle
-        $stderr.puts "WARNING: Running without SSL cert verification because #{@@ssl_bundle_path} isn't readable"
-        @no_bundle = true
-      end
-      ssl_opts = { :verify_ssl => false }
-    else
-      ssl_opts = {
-        :verify_ssl => OpenSSL::SSL::VERIFY_PEER,
-        :ssl_ca_file => @@ssl_bundle_path
-      }
+    if ssl_preflight_passed?
+      request_opts.update(:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+                          :ssl_ca_file => @ssl_bundle_path)
     end
-    uname = (@@uname ||= RUBY_PLATFORM =~ /linux|darwin/i ? `uname -a 2>/dev/null`.strip : nil)
-    lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
-    ua = {
-      :bindings_version => Stripe::VERSION,
-      :lang => 'ruby',
-      :lang_version => lang_version,
-      :platform => RUBY_PLATFORM,
-      :publisher => 'stripe',
-      :uname => uname
-    }
 
     params = Util.objects_to_ids(params)
-    url = self.api_url(url)
+    url = api_url(url)
+
     case method.to_s.downcase.to_sym
     when :get, :head, :delete
       # Make params into GET parameters
-      if params && params.count > 0
-        query_string = Util.flatten_params(params).collect{|key, value| "#{key}=#{Util.url_encode(value)}"}.join('&')
-        url += "#{URI.parse(url).query ? '&' : '?'}#{query_string}"
-      end
+      url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
       payload = nil
     else
-      payload = Util.flatten_params(params).collect{|(key, value)| "#{key}=#{Util.url_encode(value)}"}.join('&')
+      payload = uri_encode(params)
     end
 
-    begin
-      headers = { :x_stripe_client_user_agent => Stripe::JSON.dump(ua) }.merge(headers)
-    rescue => e
-      headers = {
-        :x_stripe_client_raw_user_agent => ua.inspect,
-        :error => "#{e} (#{e.class})"
-      }.merge(headers)
-    end
-
-    headers = {
-      :user_agent => "Stripe/v1 RubyBindings/#{Stripe::VERSION}",
-      :authorization => "Bearer #{api_key}",
-      :content_type => 'application/x-www-form-urlencoded'
-    }.merge(headers)
-
-    if self.api_version
-      headers[:stripe_version] = self.api_version
-    end
-
-    opts = {
-      :method => method,
-      :url => url,
-      :headers => headers,
-      :open_timeout => 30,
-      :payload => payload,
-      :timeout => 80
-    }.merge(ssl_opts)
+    request_opts.update(:headers => request_headers.update(headers),
+                        :method => method, :open_timeout => 30,
+                        :payload => payload, :url => url, :timeout => 80)
 
     begin
-      response = execute_request(opts)
+      response = execute_request(request_opts)
     rescue SocketError => e
-      self.handle_restclient_error(e)
+      handle_restclient_error(e)
     rescue NoMethodError => e
       # Work around RestClient bug
       if e.message =~ /\WRequestFailed\W/
         e = APIConnectionError.new('Unexpected HTTP response code')
-        self.handle_restclient_error(e)
+        handle_restclient_error(e)
       else
         raise
       end
     rescue RestClient::ExceptionWithResponse => e
       if rcode = e.http_code and rbody = e.http_body
-        self.handle_api_error(rcode, rbody)
+        handle_api_error(rcode, rbody)
       else
-        self.handle_restclient_error(e)
+        handle_restclient_error(e)
       end
     rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      self.handle_restclient_error(e)
+      handle_restclient_error(e)
     end
 
-    rbody = response.body
-    rcode = response.code
+    parse(response)
+  end
+
+  private
+
+  def self.ssl_preflight_passed?
+    if !verify_ssl_certs && !@no_verify
+      $stderr.puts "WARNING: Running without SSL cert verification. " +
+        "Execute 'Stripe.verify_ssl_certs = true' to enable verification."
+
+      @no_verify = true
+
+    elsif !Util.file_readable(@ssl_bundle_path) && !@no_bundle
+      $stderr.puts "WARNING: Running without SSL cert verification " +
+        "because #{@ssl_bundle_path} isn't readable"
+
+      @no_bundle = true
+    end
+
+    !(@no_verify || @no_nobundle)
+  end
+
+  def self.user_agent
+    @uname ||= get_uname
+    lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
+
+    {
+      :bindings_version => Stripe::VERSION,
+      :lang => 'ruby',
+      :lang_version => lang_version,
+      :platform => RUBY_PLATFORM,
+      :publisher => 'stripe',
+      :uname => @uname
+    }
+
+  end
+
+  def self.get_uname
+    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
+  rescue Errno::ENOMEM => ex # couldn't create subprocess
+    "uname lookup failed"
+  end
+
+  def self.uri_encode(params)
+    Util.flatten_params(params).
+      map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
+  end
+
+  def self.request_headers
+    headers = {
+      :user_agent => "Stripe/v1 RubyBindings/#{Stripe::VERSION}",
+      :authorization => "Bearer #{api_key}",
+      :content_type => 'application/x-www-form-urlencoded'
+    }
+
+    headers[:stripe_version] = api_version if api_version
+
+    begin
+      headers.update(:x_stripe_client_user_agent => Stripe::JSON.dump(user_agent))
+    rescue => e
+      headers.update(:x_stripe_client_raw_user_agent => user_agent.inspect,
+                     :error => "#{e} (#{e.class})")
+    end
+  end
+
+  def self.execute_request(opts)
+    RestClient::Request.execute(opts)
+  end
+
+  def self.parse(response)
     begin
       # Would use :symbolize_names => true, but apparently there is
       # some library out there that makes symbolize_names not work.
-      resp = Stripe::JSON.load(rbody)
+      response = Stripe::JSON.load(response.body)
     rescue MultiJson::DecodeError
-      raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+      raise general_api_error(response.code, response.body)
     end
 
-    resp = Util.symbolize_names(resp)
-    [resp, api_key]
+    [Util.symbolize_names(response), api_key]
   end
 
-  private
-
-  def self.execute_request(opts)
-    RestClient::Request.execute(opts)
+  def self.general_api_error(rcode, rbody)
+    APIError.new("Invalid response object from API: #{rbody.inspect} " +
+                 "(HTTP response code was #{rcode})", rcode, rbody)
   end
 
   def self.handle_api_error(rcode, rbody)
@@ -207,24 +208,27 @@ module Stripe
       error_obj = Stripe::JSON.load(rbody)
       error_obj = Util.symbolize_names(error_obj)
       error = error_obj[:error] or raise StripeError.new # escape from parsing
+
     rescue MultiJson::DecodeError, StripeError
-      raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+      raise general_api_error(rcode, rbody)
     end
 
     case rcode
-    when 400, 404 then
-      raise invalid_request_error(error, rcode, rbody, error_obj)
+    when 400, 404
+      raise invalid_request_error error, rcode, rbody, error_obj
     when 401
-      raise authentication_error(error, rcode, rbody, error_obj)
+      raise authentication_error error, rcode, rbody, error_obj
     when 402
-      raise card_error(error, rcode, rbody, error_obj)
+      raise card_error error, rcode, rbody, error_obj
     else
-      raise api_error(error, rcode, rbody, error_obj)
+      raise api_error error, rcode, rbody, error_obj
     end
+
   end
 
   def self.invalid_request_error(error, rcode, rbody, error_obj)
-    InvalidRequestError.new(error[:message], error[:param], rcode, rbody, error_obj)
+    InvalidRequestError.new(error[:message], error[:param], rcode,
+                            rbody, error_obj)
   end
 
   def self.authentication_error(error, rcode, rbody, error_obj)
@@ -232,7 +236,8 @@ module Stripe
   end
 
   def self.card_error(error, rcode, rbody, error_obj)
-    CardError.new(error[:message], error[:param], error[:code], rcode, rbody, error_obj)
+    CardError.new(error[:message], error[:param], error[:code],
+                  rcode, rbody, error_obj)
   end
 
   def self.api_error(error, rcode, rbody, error_obj)
@@ -242,15 +247,28 @@ module Stripe
   def self.handle_restclient_error(e)
     case e
     when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
-      message = "Could not connect to Stripe (#{@@api_base}).  Please check your internet connection and try again.  If this problem persists, you should check Stripe's service status at https://twitter.com/stripestatus, or let us know at support@stripe.com."
+      message = "Could not connect to Stripe (#{@api_base}). " +
+        "Please check your internet connection and try again. " +
+        "If this problem persists, you should check Stripe's service status at " +
+        "https://twitter.com/stripestatus, or let us know at support@stripe.com."
+
     when RestClient::SSLCertificateNotVerified
-      message = "Could not verify Stripe's SSL certificate.  Please make sure that your network is not intercepting certificates.  (Try going to https://api.stripe.com/v1 in your browser.)  If this problem persists, let us know at support@stripe.com."
+      message = "Could not verify Stripe's SSL certificate. " +
+        "Please make sure that your network is not intercepting certificates. " +
+        "(Try going to https://api.stripe.com/v1 in your browser.) " +
+        "If this problem persists, let us know at support@stripe.com."
+
     when SocketError
-      message = "Unexpected error communicating when trying to connect to Stripe.  HINT: You may be seeing this message because your DNS is not working.  To check, try running 'host stripe.com' from the command line."
+      message = "Unexpected error communicating when trying to connect to Stripe. " +
+        "You may be seeing this message because your DNS is not working. " +
+        "To check, try running 'host stripe.com' from the command line."
+
     else
-      message = "Unexpected error communicating with Stripe.  If this problem persists, let us know at support@stripe.com."
+      message = "Unexpected error communicating with Stripe. " +
+        "If this problem persists, let us know at support@stripe.com."
+
     end
-    message += "\n\n(Network error: #{e.message})"
-    raise APIConnectionError.new(message)
+
+    raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
   end
 end

data/lib/stripe/api_operations/update.rb

@@ -5,6 +5,7 @@ module Stripe
         if @unsaved_values.length > 0
           values = {}
           @unsaved_values.each { |k| values[k] = @values[k] }
+          values.delete(:id)
           response, api_key = Stripe.request(:post, url, @api_key, values)
           refresh_from(response, api_key)
         end

data/lib/stripe/customer.rb

@@ -17,6 +17,10 @@ module Stripe
       InvoiceItem.all({ :customer => id }, @api_key)
     end
 
+    def upcoming_invoice
+      Invoice.upcoming({ :customer => id }, @api_key)
+    end
+
     def charges
       Charge.all({ :customer => id }, @api_key)
     end

data/lib/stripe/stripe_object.rb

@@ -70,8 +70,7 @@ module Stripe
     end
 
     def [](k)
-      k = k.to_sym if k.kind_of?(String)
-      @values[k]
+      @values[k.to_sym]
     end
 
     def []=(k, v)

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.8.1'
+  VERSION = '1.8.2'
 end

data/test/test_stripe.rb

@@ -81,6 +81,13 @@ class TestStripeRuby < Test::Unit::TestCase
       end
     end
 
+    should "specifying api credentials containing whitespace should raise an exception" do
+      Stripe.api_key = "key "
+      assert_raises Stripe::AuthenticationError do
+        Stripe::Customer.new("test_customer").refresh
+      end
+    end
+
     should "specifying invalid api credentials should raise an exception" do
       Stripe.api_key = "invalid"
       response = test_response(test_invalid_api_key_error, 401)
@@ -431,7 +438,7 @@ class TestStripeRuby < Test::Unit::TestCase
           c = Stripe::Customer.retrieve("test_customer")
 
           # Not an accurate response, but whatever
-          
+
           @mock.expects(:delete).once.with("#{Stripe.api_base}/v1/customers/c_test_customer/subscription?at_period_end=true", nil, nil).returns(test_response(test_subscription('silver')))
           s = c.cancel_subscription({:at_period_end => 'true'})
 
@@ -447,6 +454,15 @@ class TestStripeRuby < Test::Unit::TestCase
           s = c.delete_discount
           assert_equal nil, c.discount
         end
+
+        should "be able to update a customer without refreshing it first" do
+          @mock.expects(:post).once.with("#{Stripe.api_base}/v1/customers/test_customer", nil, 'mnemonic=bar').returns(test_response(test_customer({:mnemonic => "bar"})))
+          c = Stripe::Customer.new("test_customer")
+          c.mnemonic = "bar"
+          c.save
+          assert_equal c.mnemonic, "bar"
+        end
+
       end
 
       context "card tests" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -199,3 +199,4 @@ test_files:
 - test/test_helper.rb
 - test/test_stripe.rb
 - test/test_stripe_with_active_support.rb
+has_rdoc: