facebook_commerce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20696062e7f6acdd971a438426a5fca169814aa90aa0182dee07e88c5cf77a2f
+  data.tar.gz: 56837aeacd2b316bb7bcc7ce16351f4dee3fadb91fb766cb13b60ed014ced976
+SHA512:
+  metadata.gz: 90425ba85eaf12f79e96ae2db351ac45483e3bcda6260d4cb04ba1d1af2fa9ff36a1bcf9c52d77125a178e95c85deb9403e9eb649eeeef171d4de8b73ed240b3
+  data.tar.gz: 26afb26eb116a583e12d0515fdfa457729fcf6f568b831a77ffcd70097251627adc64bee59178a87fd5d55ac4cf3746f89f4e0f228362ab2b85acb9b0454b94c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in facebook_commerce.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Piers Chambers
+
+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,33 @@
+# FacebookCommerce
+
+Unofficial Ruby wrapper for the Facebook Commerce API.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/varyonic/facebook_commerce.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/facebook_commerce/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FacebookCommerce
+  VERSION = "0.1.0"
+end

data/lib/facebook_commerce.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require_relative "facebook_commerce/version"
+
+require 'benchmark'
+require 'json'
+require 'logger'
+require 'securerandom'
+
+module FacebookCommerce
+  BASE_URL = 'https://graph.facebook.com/'
+  class Error < StandardError; end
+
+  def self.configure(&block)
+    yield @config
+  end
+
+  def config
+    @config
+  end
+
+  class Api
+    class UnexpectedHttpResponse < StandardError
+      def initialize(response)
+        super response.message || response.code
+      end
+    end
+    
+    attr_reader :access_token # See https://business.facebook.com/commerce_permission_wizard
+    attr_reader :cms_id
+    attr_accessor :logger
+
+    # config[:cms_id]
+    # config[:access_token]
+    def initialize(config = super.config)
+      @cms_id = config.fetch(:cms_id)
+      @access_token = config.fetch(:access_token)
+      @logger = config[:logger] || Logger.new(STDOUT)
+    end
+
+    protected
+
+    def get(path, data = {})
+      path = "#{path}?#{URI.encode_www_form(data.merge(access_token: access_token))}"
+      JSON.parse(send_request('GET', BASE_URL + path))
+    end
+
+    def post(path, data = {})
+      data.merge!(access_token: access_token)
+      JSON.parse(send_request('POST', BASE_URL + path, data))
+    end
+
+    # Accepts hash of fields to send.
+    # Returns response body if successful else raises exception.
+    def send_request(method, path, fields = {})
+      uri = URI(path)
+      connection = https(uri)
+      data = fields.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+      response = log_request_response(method, uri, data) do |m, u, d|
+        connection.send_request(m, u.to_s, d)
+      end
+      fail_unless_expected_response response, Net::HTTPSuccess
+      response.body
+    end
+
+    def https(uri)
+      Net::HTTP.new(uri.host, uri.port).tap do |http|
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+  
+    # Log method, URI, data
+    # Start timer.
+    # Yield method, URI, data.
+    # Log response and time taken.
+    def log_request_response(method, uri, data = nil)
+      logger.info "[#{self.class.name}] request = #{method} #{uri}#{data ? '?' + data : ''}"
+      response = nil
+      tms = Benchmark.measure do
+        response = yield method, uri, data
+      end
+      logger.info("[#{self.class.name}] response (#{(tms.real*1000).round(3)}ms): #{response.inspect} #{response.body}")
+      response
+    end
+
+    def fail_unless_expected_response(response, *allowed_responses)
+      unless allowed_responses.any? { |allowed| response.is_a?(allowed) }
+        logger.error "#{response.inspect}: #{response.body}"
+        raise UnexpectedHttpResponse, response
+      end
+      response
+    end
+  end
+
+  # https://developers.facebook.com/docs/commerce-platform/order-management/order-api
+  class OrderApi < Api
+    # By default the list_orders method will return orders in the CREATED state.
+    # @option params updated_before [String] Unix timestamp
+    # @option params updated_after [String] Unix timestamp
+    # state The state of the order. The default is CREATED. FB_PROCESSING, IN_PROGRESS, COMPLETED
+    def list_orders(params = {})
+      get("#{cms_id}/commerce_orders", params).fetch('data')
+    end
+
+    # @param order_id [String]
+    # @option params fields [String] Comma-separated list of fields to include in the response
+    def get_order_details(order_id, params = {})
+      get(order_id, params)
+    end
+  end
+
+  # https://developers.facebook.com/docs/commerce-platform/order-management/acknowledgement-api
+  class AcknowledgementApi < Api
+    def associate_app
+      post("#{cms_id}/order_management_apps")
+    end
+
+    def acknowledge_order(order_id, merchant_order_reference = nil)
+      data = { idempotency_key: SecureRandom.uuid }
+      data[:merchant_order_reference] = merchant_order_reference if merchant_order_reference
+      post("#{order_id}/acknowledge_order", data)
+    end
+  end
+
+  # https://developers.facebook.com/docs/commerce-platform/order-management/fulfillment-api
+  class FulfillmentApi < Api
+    # @param order_id [String] Facebook order ID
+    # @param items [Array<Hash>] Array of item hashes (retailer_id|product_id, quantity)
+    # @param tracking_info [Hash] Tracking information (carrier, tracking_number, shipping_method_name)
+    def attach_shipment(order_id, items, tracking_info, external_shipment_id = nil)
+      data = { 
+        items: items.to_json,
+        tracking_info: tracking_info.to_json,
+        idempotency_key: SecureRandom.uuid
+      }
+      data[:external_shipment_id] = external_shipment_id if external_shipment_id
+
+      post("#{order_id}/shipments", data)
+    end
+  end
+
+  class CancellationRefundApi < Api
+    # @param order_id [String] Facebook order ID
+    # @return [Hash] Cancellation response, eg. { success: true}
+    def cancel_order(order_id)
+      data = { idempotency_key: SecureRandom.uuid }
+      post("#{order_id}/cancellations", data)
+    end
+
+    # @param order_id [String] Facebook order ID
+    # @param reason_code [String] Reason code for the refund, eg. 'REFUND_REASON_OTHER'
+    # @param items [Array<Hash>] Item hashes (retailer_id|product_id, quantity), required if partial refund
+    # @return [Hash] Refund response, eg. { success: true}
+    def refund_order(order_id, reason_code, items = nil)
+      data = { reason_code: reason_code, idempotency_key: SecureRandom.uuid }
+      post("#{order_id}/refunds", data)
+    end
+  end
+
+  class ReturnApi < Api
+    # @param order_id [String] Facebook order ID
+    # @param items [Array<Hash>] Array of item hashes (item_id|retailer_id, quantity, reason)
+    # @param return_status [String] Reason code for the return,
+    #   eg. 'REQUESTED', 'APPROVED', 'DISAPPROVED', 'REFUNDED', 'MERCHANT_MARKED_COMPLETED'
+    # @return [Hash] Return response, eg. { id: '1234567890' }
+    def create_return(order_id, items, return_status, return_message, merchant_return_id)
+      data = {
+        items: items.to_json,
+        return_status: return_status,
+        return_message: return_message,
+        merchant_return_id: merchant_return_id
+      }
+      post("#{order_id}/returns", data)
+    end
+
+    # @param return_id [String] Facebook return ID
+    # @param update_event [String] Reason code for the return, 'ACCEPT_RETURN' or 'CLOSE_RETURN'
+    # @option options [String] notes Notes for the return
+    # @option options [String] merchant_return_id Merchant return ID
+    # @option options [Array<Hash>] return_shipping_labels Array of shipping label hashes
+    #         (carrier, service_name, tracking_number, file_handle, cost)
+    def update_return(return_id, update_event, options = {})
+      post("#{return_id}/update_return", options.merge(update_event: update_event))
+    end
+  end
+end

data/sig/facebook_commerce.rbs

@@ -0,0 +1,4 @@
+module FacebookCommerce
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: facebook_commerce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piers Chambers
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-06 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- piers@varyonic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/facebook_commerce.rb
+- lib/facebook_commerce/version.rb
+- sig/facebook_commerce.rbs
+homepage: https://github.com/varyonic/facebook_commerce
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/varyonic/facebook_commerce
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Unofficial Ruby wrapper for the Facebook Commerce API.
+test_files: []