stripe 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b491a85852c3b17ea12c480ae456f163e0862d9
-  data.tar.gz: d1c4cefdc8963ebf96bf7e68c2319e55d95c04a1
+  metadata.gz: fa5a5d77a37b6f87fe0e40d1eb03072b82d0b4cf
+  data.tar.gz: aacdfe4bb67bdc6671e300a899a0e9cf037332ac
 SHA512:
-  metadata.gz: 2d38841dad3272ef61d8658def6fbaf5b153c011a832f3e5a13c076bfd740a363e86980fb7cee7d89c693fd4c33a6f82e256a9d6fdd263ea53d03ef830aeebeb
-  data.tar.gz: 8384f1ab4c1416cea101e424c431707ab10a703d986418c6aa77aa323feed629005532a8634ad6bb099195564a9727f7288693c1cb79d8bf02fe883507e103fd
+  metadata.gz: 79d65a44f1a015f5d052396ae54a7a103ff35821ea9b7e290e52f0aa35b5ed0e70f0e9c2230a0ee8cbc2e03508517a4d8bcad79e3248ce2d08a869febfa08207
+  data.tar.gz: c57103af7cdbf0026211c11a121764bb02f859d00ad822cb29ec49f5a45181274a06c6cb54f86fb9cb9a28e27231490e836b2b29dc4d62273387f66b79653b93

data/History.txt

@@ -1,3 +1,7 @@
+=== 2.4.0 2017-04-18
+
+* Add `Stripe.set_app_info` for use by plugin creators
+
 === 2.3.0 2017-04-14
 
 * Add question mark accessor when assigning boolean value to undefined field

data/README.md

@@ -122,6 +122,16 @@ an intermittent network problem:
 [Idempotency keys][idempotency-keys] are added to requests to guarantee that
 retries are safe.
 
+### Writing a Plugin
+
+If you're writing a plugin that uses the library, we'd appreciate it if you
+identified using `#set_app_info`:
+
+    Stripe.set_app_info("MyAwesomePlugin", version: "1.2.34", url: "https://myawesomeplugin.info");
+
+This information is passed along when the library makes calls to the Stripe
+API.
+
 ## Development
 
 Run all tests:

data/VERSION

@@ -1 +1 @@
-2.3.0
+2.4.0

data/lib/stripe.rb

@@ -70,6 +70,8 @@ require 'stripe/transfer'
 module Stripe
   DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
 
+  @app_info = nil
+
   @api_base = 'https://api.stripe.com'
   @connect_base = 'https://connect.stripe.com'
   @uploads_base = 'https://uploads.stripe.com'
@@ -92,6 +94,16 @@ module Stripe
     attr_reader :max_network_retry_delay, :initial_network_retry_delay
   end
 
+  # Gets the application for a plugin that's identified some. See
+  # #set_app_info.
+  def self.app_info
+    @app_info
+  end
+
+  def self.app_info=(info)
+    @app_info = info
+  end
+
   # The location of a file containing a bundle of CA certificates. By default
   # the library will use an included bundle that can successfully validate
   # Stripe certificates.
@@ -131,6 +143,19 @@ module Stripe
     @max_network_retries = val.to_i
   end
 
+  # Sets some basic information about the running application that's sent along
+  # with API requests. Useful for plugin authors to identify their plugin when
+  # communicating with Stripe.
+  #
+  # Takes a name and optional version and plugin URL.
+  def self.set_app_info(name, version: nil, url: nil)
+    @app_info = {
+      name: name,
+      url: url,
+      version: version,
+    }
+  end
+
   private
 
   # DEPRECATED. Use `Util#encode_parameters` instead.

data/lib/stripe/stripe_client.rb

@@ -218,6 +218,16 @@ module Stripe
                    http_status: status, http_body: body)
     end
 
+    # Formats a plugin "app info" hash into a string that we can tack onto the
+    # end of a User-Agent string where it'll be fairly prominant in places like
+    # the Dashboard. Note that this formatting has been implemented to match
+    # other libraries, and shouldn't be changed without universal consensus.
+    def format_app_info(info)
+      str = info[:name]
+      str = "#{str}/#{info[:version]}" unless info[:version].nil?
+      str = "#{str} (#{info[:url]})" unless info[:url].nil?
+      str
+    end
 
     def handle_api_error(http_resp)
       begin
@@ -309,8 +319,13 @@ module Stripe
     end
 
     def request_headers(api_key, method)
+      user_agent = "Stripe/v1 RubyBindings/#{Stripe::VERSION}"
+      unless Stripe.app_info.nil?
+        user_agent += " " + format_app_info(Stripe.app_info)
+      end
+
       headers = {
-        'User-Agent' => "Stripe/v1 RubyBindings/#{Stripe::VERSION}",
+        'User-Agent' => user_agent,
         'Authorization' => "Bearer #{api_key}",
         'Content-Type' => 'application/x-www-form-urlencoded'
       }
@@ -382,6 +397,7 @@ module Stripe
         lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
 
         {
+          :application => Stripe.app_info,
           :bindings_version => Stripe::VERSION,
           :lang => 'ruby',
           :lang_version => lang_version,
@@ -390,7 +406,7 @@ module Stripe
           :publisher => 'stripe',
           :uname => @uname,
           :hostname => Socket.gethostname,
-        }
+        }.delete_if { |k, v| v.nil? }
       end
     end
   end

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/test/stripe/stripe_client_test.rb

@@ -143,14 +143,19 @@ module Stripe
 
       context "Stripe-Account header" do
         should "use a globally set header" do
-          Stripe.stripe_account = 'acct_1234'
+          begin
+            old = Stripe.stripe_account
+            Stripe.stripe_account = 'acct_1234'
 
-          stub_request(:post, "#{Stripe.api_base}/v1/account").
-            with(headers: {"Stripe-Account" => Stripe.stripe_account}).
-            to_return(body: JSON.generate(API_FIXTURES.fetch(:account)))
+            stub_request(:post, "#{Stripe.api_base}/v1/account").
+              with(headers: {"Stripe-Account" => Stripe.stripe_account}).
+              to_return(body: JSON.generate(API_FIXTURES.fetch(:account)))
 
-          client = StripeClient.new
-          client.execute_request(:post, '/v1/account')
+            client = StripeClient.new
+            client.execute_request(:post, '/v1/account')
+          ensure
+            Stripe.stripe_account = old
+          end
         end
 
         should "use a locally set header" do
@@ -176,6 +181,43 @@ module Stripe
         end
       end
 
+      context "app_info" do
+        should "send app_info if set" do
+          begin
+            old = Stripe.app_info
+            Stripe.set_app_info(
+              "MyAwesomePlugin",
+              url: "https://myawesomeplugin.info",
+              version: "1.2.34"
+            )
+
+            stub_request(:post, "#{Stripe.api_base}/v1/account").
+              with { |req|
+                assert_equal \
+                  "Stripe/v1 RubyBindings/#{Stripe::VERSION} " \
+                  "MyAwesomePlugin/1.2.34 (https://myawesomeplugin.info)",
+                  req.headers["User-Agent"]
+
+                data = JSON.parse(req.headers["X-Stripe-Client-User-Agent"],
+                  symbolize_names: true)
+
+                assert_equal({
+                  name: "MyAwesomePlugin",
+                  url: "https://myawesomeplugin.info",
+                  version: "1.2.34"
+                }, data[:application])
+
+                true
+              }.to_return(body: JSON.generate(API_FIXTURES.fetch(:account)))
+
+            client = StripeClient.new
+            client.execute_request(:post, '/v1/account')
+          ensure
+            Stripe.app_info = old
+          end
+        end
+      end
+
       context "error handling" do
         should "handle error response with empty body" do
           stub_request(:post, "#{Stripe.api_base}/v1/charges").

data/test/stripe_test.rb

@@ -14,6 +14,24 @@ class StripeTest < Test::Unit::TestCase
     end
   end
 
+  should "allow app_info to be configured" do
+    begin
+      old = Stripe.app_info
+      Stripe.set_app_info(
+        "MyAwesomePlugin",
+        url: "https://myawesomeplugin.info",
+        version: "1.2.34"
+      )
+      assert_equal({
+        name: "MyAwesomePlugin",
+        url: "https://myawesomeplugin.info",
+        version: "1.2.34"
+      }, Stripe.app_info)
+    ensure
+      Stripe.app_info = old
+    end
+  end
+
   should "allow ca_bundle_path to be configured" do
     begin
       old = Stripe.ca_bundle_path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday