RubyGems - affirm-ruby-v1 - Versions diffs - 1.1.0 - Mend

affirm-ruby-v1 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (32) hide show

checksums.yaml +7 -0
data/.rspec +2 -0
data/CHANGELOG.md +21 -0
data/Gemfile +3 -0
data/LICENSE.txt +22 -0
data/README.md +113 -0
data/Rakefile +19 -0
data/lib/affirm/charge.rb +63 -0
data/lib/affirm/client.rb +50 -0
data/lib/affirm/configuration.rb +38 -0
data/lib/affirm/failure_result.rb +18 -0
data/lib/affirm/objects/event.rb +14 -0
data/lib/affirm/responses/auth.rb +23 -0
data/lib/affirm/responses/capture.rb +16 -0
data/lib/affirm/responses/error.rb +13 -0
data/lib/affirm/responses/refund.rb +14 -0
data/lib/affirm/responses/update.rb +14 -0
data/lib/affirm/responses/void.rb +12 -0
data/lib/affirm/success_result.rb +26 -0
data/lib/affirm/version.rb +3 -0
data/lib/affirm.rb +19 -0
data/spec/charge_object_interface.rb +45 -0
data/spec/charge_spec.rb +432 -0
data/spec/client_spec.rb +135 -0
data/spec/configuration_spec.rb +96 -0
data/spec/failure_result_spec.rb +71 -0
data/spec/fixtures/auth.json +22 -0
data/spec/helper.rb +7 -0
data/spec/integration/sandbox_spec.rb +61 -0
data/spec/spec_helper.rb +91 -0
data/spec/success_result_spec.rb +31 -0
metadata +216 -0

data/spec/charge_spec.rb ADDED Viewed

@@ -0,0 +1,432 @@
+require "helper"
+require_relative "charge_object_interface"
+RSpec.describe Affirm::Charge do
+  let(:failed_response) { double(:response, success?: false, body: Hash.new) }
+  context "authorize" do
+    context "with failed response" do
+      subject { described_class }
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions", transaction_id: "ABC", order_id: "ORDER-1")
+          .and_return(failed_response)
+      end
+      it "returns failure object" do
+        expect(
+          subject.authorize("ABC", "ORDER-1")
+        ).to be_an_instance_of(Affirm::FailureResult)
+      end
+    end
+    context "with successful response" do
+      subject { described_class.authorize("ABC", "ORDER-1") }
+      let(:body) do
+        JSON.load(
+          File.read(File.expand_path("../fixtures/auth.json", __FILE__))
+        )
+      end
+      let(:successful_response) do
+        double(:response, success?: true, body: body)
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions", transaction_id: "ABC", order_id: "ORDER-1")
+          .and_return(successful_response)
+      end
+      it_behaves_like "a transaction object interface"
+    end
+    context "with reference_id" do
+      subject { described_class.authorize("ABC", "ORDER-1", reference_id: "REF-9") }
+      let(:successful_response) do
+        double(:response, success?: true, body: { "id" => "TX-1", "status" => "authorized" })
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions", transaction_id: "ABC", order_id: "ORDER-1", reference_id: "REF-9")
+          .and_return(successful_response)
+      end
+      it "returns success" do
+        expect(subject).to be_success
+      end
+    end
+    context "without order_id" do
+      it "raises ArgumentError when nil" do
+        expect {
+          described_class.authorize("ABC", nil)
+        }.to raise_error(ArgumentError, /order_id is required/)
+      end
+      it "raises ArgumentError when empty string" do
+        expect {
+          described_class.authorize("ABC", "")
+        }.to raise_error(ArgumentError, /order_id is required/)
+      end
+    end
+    context "with successful response but non-Hash body" do
+      subject { described_class.authorize("ABC", "ORDER-1") }
+      let(:non_hash_response) do
+        double(:response, success?: true, body: "<html>Bad Gateway</html>")
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions", transaction_id: "ABC", order_id: "ORDER-1")
+          .and_return(non_hash_response)
+      end
+      it "returns failure object" do
+        expect(subject).to be_an_instance_of(Affirm::FailureResult)
+      end
+    end
+    context "with successful response and no type field" do
+      subject { described_class.authorize("ABC", "ORDER-1") }
+      let(:body) do
+        JSON.load(
+          File.read(File.expand_path("../fixtures/auth.json", __FILE__))
+        )
+      end
+      let(:successful_response) do
+        double(:response, success?: true, body: body)
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions", transaction_id: "ABC", order_id: "ORDER-1")
+          .and_return(successful_response)
+      end
+      it "wraps an Auth response in a SuccessResult" do
+        expect(subject).to be_an_instance_of(Affirm::SuccessResult)
+        expect(subject.__send__(:object)).to be_an_instance_of(Affirm::Responses::Auth)
+      end
+    end
+  end
+  context "find" do
+    context "with failed response" do
+      subject { described_class }
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:get, "transactions/1")
+          .and_return(failed_response)
+      end
+      it "returns failure object" do
+        expect(
+          subject.find(1)
+        ).to be_an_instance_of(Affirm::FailureResult)
+      end
+    end
+    context "with successful response" do
+      subject { described_class.find("ABC") }
+      let(:body) do
+        JSON.load(
+          File.read(File.expand_path("../fixtures/auth.json", __FILE__))
+        )
+      end
+      let(:successful_response) do
+        double(:response, success?: true, body: body)
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:get, "transactions/ABC")
+          .and_return(successful_response)
+      end
+      it_behaves_like "a transaction object interface"
+    end
+  end
+  context "capture" do
+    context "with failed response" do
+      subject { described_class }
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/capture")
+          .and_return(failed_response)
+      end
+      it "returns failure object" do
+        expect(
+          subject.capture(1)
+        ).to be_an_instance_of(Affirm::FailureResult)
+      end
+    end
+    context "with successful response" do
+      subject { described_class.capture(1) }
+      let(:body) do
+        {
+          "id"           => "ABC-111",
+          "order_id"     => "XYZ-999",
+          "currency"     => "USD",
+          "amount"       => 100,
+          "fee"          => 10,
+          "created"      => Time.local(2015, 1, 1),
+          "type"         => "capture",
+          "reference_id" => "REF-1"
+        }
+      end
+      let(:successful_response) do
+        double(:response, success?: true, body: body)
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/capture")
+          .and_return(successful_response)
+      end
+      %w(
+        id
+        reference_id
+        order_id
+        currency
+        amount
+        fee
+        type
+      ).each do |method|
+        it method do
+          expect(subject.public_send(method)).to eq(body[method])
+        end
+      end
+      it "created" do
+        expect(to_seconds(subject.created)).to eq(to_seconds(body["created"]))
+      end
+    end
+    context "with capture options" do
+      subject { described_class.capture(1, amount: 100, order_id: "O1") }
+      let(:successful_response) do
+        double(:response, success?: true, body: { "type" => "capture", "id" => "CAP-1" })
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/capture", amount: 100, order_id: "O1")
+          .and_return(successful_response)
+      end
+      it "returns success" do
+        expect(subject).to be_success
+      end
+    end
+  end
+  context "void" do
+    context "with failed response" do
+      subject { described_class }
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/void")
+          .and_return(failed_response)
+      end
+      it "returns failure object" do
+        expect(
+          subject.void(1)
+        ).to be_an_instance_of(Affirm::FailureResult)
+      end
+    end
+    context "with successful response" do
+      subject { described_class.void(1) }
+      let(:body) do
+        {
+          "id"           => "ABC-111",
+          "reference_id" => "XYZ-999",
+          "created"      => Time.local(2015, 1, 1),
+          "type"         => "void"
+        }
+      end
+      let(:successful_response) do
+        double(:response, success?: true, body: body)
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/void")
+          .and_return(successful_response)
+      end
+      %w(
+        id
+        reference_id
+        type
+      ).each do |method|
+        it method do
+          expect(subject.public_send(method)).to eq(body[method])
+        end
+      end
+      it "created" do
+        expect(to_seconds(subject.created)).to eq(to_seconds(body["created"]))
+      end
+    end
+  end
+  context "refund" do
+    context "with failed response" do
+      subject { described_class }
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/refund", amount: 50)
+          .and_return(failed_response)
+      end
+      it "returns failure object" do
+        expect(
+          subject.refund(1, amount: 50)
+        ).to be_an_instance_of(Affirm::FailureResult)
+      end
+    end
+    context "with successful response" do
+      subject { described_class.refund(1, amount: 50) }
+      let(:body) do
+        {
+          "id"           => "ABC-111",
+          "reference_id" => "XYZ-999",
+          "amount"       => 50,
+          "fee_refunded" => 0,
+          "created"      => Time.local(2015, 1, 1),
+          "type"         => "refund"
+        }
+      end
+      let(:successful_response) do
+        double(:response, success?: true, body: body)
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/refund", amount: 50)
+          .and_return(successful_response)
+      end
+      %w(
+        id
+        reference_id
+        amount
+        fee_refunded
+        type
+      ).each do |method|
+        it method do
+          expect(subject.public_send(method)).to eq(body[method])
+        end
+      end
+      it "created" do
+        expect(to_seconds(subject.created)).to eq(to_seconds(body["created"]))
+      end
+    end
+  end
+  context "update" do
+    context "with failed response" do
+      subject { described_class }
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/update",
+            order_id: "XYZ-007",
+            shipping_carrier: "FedEx",
+            shipping_confirmation: "1ZX007")
+          .and_return(failed_response)
+      end
+      it "returns failure object" do
+        expect(
+          subject.update(1,
+            order_id: "XYZ-007",
+            shipping_carrier: "FedEx",
+            shipping_confirmation: "1ZX007"
+          )
+        ).to be_an_instance_of(Affirm::FailureResult)
+      end
+    end
+    context "with successful response" do
+      subject do
+        described_class.update(1,
+          order_id: "XYZ-007",
+          shipping_carrier: "FedEx",
+          shipping_confirmation: "1ZX007"
+        )
+      end
+      let(:body) do
+        {
+          "id"                    => "ABC-007",
+          "order_id"              => "XYZ-007",
+          "shipping_carrier"      => "FedEx",
+          "shipping_confirmation" => "1ZX007",
+          "created"               => Time.local(2015, 1, 1),
+          "type"                  => "update"
+        }
+      end
+      let(:successful_response) do
+        double(:response, success?: true, body: body)
+      end
+      before do
+        expect(Affirm::Client).to receive(:request)
+          .with(:post, "transactions/1/update",
+            order_id: "XYZ-007",
+            shipping_carrier: "FedEx",
+            shipping_confirmation: "1ZX007"
+          )
+          .and_return(successful_response)
+      end
+      %w(
+        id
+        order_id
+        shipping_carrier
+        shipping_confirmation
+        type
+      ).each do |method|
+        it method do
+          expect(subject.public_send(method)).to eq(body[method])
+        end
+      end
+      it "created" do
+        expect(to_seconds(subject.created)).to eq(to_seconds(body["created"]))
+      end
+    end
+  end
+end

data/spec/client_spec.rb ADDED Viewed

@@ -0,0 +1,135 @@
+require "helper"
+RSpec.describe Affirm::Client do
+  context "new instance" do
+    it "creates Faraday connection" do
+      expect(subject.connection).to be_an_instance_of(Faraday::Connection)
+    end
+  end
+  context ".request" do
+    it "dispatches :get to a new instance" do
+      instance = instance_double(described_class, get: :ok)
+      expect(described_class).to receive(:new).and_return(instance)
+      expect(instance).to receive(:get).with("transactions/1", { foo: "bar" }).and_return(:ok)
+      expect(
+        described_class.request(:get, "transactions/1", { foo: "bar" })
+      ).to eq(:ok)
+    end
+    it "dispatches :post to a new instance" do
+      instance = instance_double(described_class, post: :ok)
+      expect(described_class).to receive(:new).and_return(instance)
+      expect(instance).to receive(:post).with("transactions", { transaction_id: "ABC" }).and_return(:ok)
+      expect(
+        described_class.request(:post, "transactions", { transaction_id: "ABC" })
+      ).to eq(:ok)
+    end
+    it "defaults data to an empty hash" do
+      instance = instance_double(described_class, get: :ok)
+      expect(described_class).to receive(:new).and_return(instance)
+      expect(instance).to receive(:get).with("transactions/1", {}).and_return(:ok)
+      described_class.request(:get, "transactions/1")
+    end
+  end
+  context "with api keys set" do
+    before do
+      Affirm.configure do |config|
+        config.public_api_key  = "abc"
+        config.private_api_key = "xyz"
+      end
+    end
+    it "sets json handlers" do
+      expect(
+        subject.connection.builder.handlers.map(&:klass)
+      ).to include(Faraday::Request::Json, Faraday::Response::Json)
+    end
+    it "sets basic auth header" do
+      stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get("/api/v1/auth-check") do |env|
+          expect(env.request_headers["Authorization"]).to eq("Basic YWJjOnh5eg==")
+          [200, {}, ""]
+        end
+      end
+      subject.connection.builder.handlers.pop
+      subject.connection.adapter(:test, stubs)
+      expect(subject.get("auth-check")).to be_success
+      stubs.verify_stubbed_calls
+    end
+  end
+  context "post request" do
+    before(:all) do
+      @stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post("/api/v1/foo") { [200, {}, ""] }
+        stub.post("/api/v1/bar", '{"key":"value"}') { [200, {}, ""] }
+      end
+    end
+    after(:all) { @stubs.verify_stubbed_calls }
+    before do
+      subject.connection.builder.handlers.pop
+      subject.connection.adapter(:test, @stubs)
+    end
+    it "makes request to full url" do
+      response = subject.post("foo", {})
+      expect(response.env.url.to_s).to eq("https://api.affirm.com/api/v1/foo")
+    end
+    it "makes request to specified path with no leading slash specified" do
+      expect(subject.post("foo")).to be_success
+    end
+    it "makes request to specified path with leading slash specified" do
+      expect(subject.post("/foo")).to be_success
+    end
+    it "makes request with json data" do
+      expect(subject.post("/bar", { key: "value" })).to be_success
+    end
+  end
+  context "get request" do
+    before(:all) do
+      @stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get("/api/v1/foo") { [200, {}, ""] }
+        stub.get("/api/v1/bar?key=value") { [200, {}, ""] }
+      end
+    end
+    after(:all) { @stubs.verify_stubbed_calls }
+    before do
+      subject.connection.builder.handlers.pop
+      subject.connection.adapter(:test, @stubs)
+    end
+    it "makes request to full url" do
+      response = subject.get("foo", {})
+      expect(response.env.url.to_s).to eq("https://api.affirm.com/api/v1/foo")
+    end
+    it "makes request to specified path with no leading slash specified" do
+      expect(subject.get("foo")).to be_success
+    end
+    it "makes request to specified path with leading slash specified" do
+      expect(subject.get("/foo")).to be_success
+    end
+    it "makes request with params" do
+      expect(subject.get("/bar", { key: "value" })).to be_success
+    end
+  end
+end

data/spec/configuration_spec.rb ADDED Viewed

@@ -0,0 +1,96 @@
+require "helper"
+RSpec.describe Affirm::Configuration do
+  after { restore_config }
+  context "when public_api_key is specified" do
+    before do
+      Affirm.configure do |config|
+        config.public_api_key = "abc"
+      end
+    end
+    it "returns public api key" do
+      expect(Affirm.configuration.public_api_key).to eq("abc")
+    end
+  end
+  context "when private_api_key is specified" do
+    before do
+      Affirm.configure do |config|
+        config.private_api_key = "xyz"
+      end
+    end
+    it "returns private api key" do
+      expect(Affirm.configuration.private_api_key).to eq("xyz")
+    end
+  end
+  context "when environment is not specified" do
+    before do
+      Affirm.configure {}
+    end
+    it "defaults to production" do
+      expect(Affirm.configuration.environment).to eq(:production)
+    end
+  end
+  context "when environment is set to production" do
+    before do
+      Affirm.configure do |config|
+        config.environment = :production
+      end
+    end
+    it "sets environment to production" do
+      expect(Affirm.configuration.environment).to eq(:production)
+    end
+    it "sets endpoint to production" do
+      expect(Affirm.configuration.endpoint).to eq("https://api.affirm.com")
+    end
+  end
+  context "when environment is set to sandbox" do
+    context "via string" do
+      before do
+        Affirm.configure do |config|
+          config.environment = 'sandbox'
+        end
+      end
+      it "sets environment to sandbox" do
+        expect(Affirm.configuration.environment).to eq(:sandbox)
+      end
+      it "sets endpoint to sandbox" do
+        expect(Affirm.configuration.endpoint).to eq("https://sandbox.affirm.com")
+      end
+    end
+    context "via symbol" do
+      before do
+        Affirm.configure do |config|
+          config.environment = :sandbox
+        end
+      end
+      it "sets environment to sandbox" do
+        expect(Affirm.configuration.environment).to eq(:sandbox)
+      end
+      it "sets endpoint to sandbox" do
+        expect(Affirm.configuration.endpoint).to eq("https://sandbox.affirm.com")
+      end
+    end
+  end
+  private
+  def restore_config
+    Affirm.configuration = nil
+    Affirm.configure {}
+  end
+end