squarespace_api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc908a714e0fa1658267c8753adcbd9085e87bd2b0b46a108231e06b53a20f6b
+  data.tar.gz: 18a4ba216bc82ab428b5ee8c7352f4f8a23d9ab98630f6a469961860242a8871
+SHA512:
+  metadata.gz: b2f62e190db5adc017b6d47933fc0e5fe28e10199098c1f148a1f4d2a10b7e5ec7efc95392f6afc22a2a53844d893733e1c815abba7d42135744332593640189
+  data.tar.gz: 73283ff1f0f272f39b3cd46c8db5651ae8316539663276f6225b0608c2304a637c02e37fd9d529fb300b33e1436a3f874a871cd014db148ce4d339b0d377999a

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    squarespace_api (0.0.3)
+      faraday
+      faraday_middleware
+      json
+      yaml
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    faraday (1.7.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    json (2.5.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yaml (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rspec
+  squarespace_api!
+  webmock
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,3 @@
+# Squarespace Api
+
+Ruby interface to the Squarespace API

data/lib/helper/string.rb

@@ -0,0 +1,13 @@
+class String
+  def to_snakecase
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+  def to_camelcase
+    self.split('_').collect(&:capitalize).join
+  end
+end

data/lib/helper/uri_component_builder.rb

@@ -0,0 +1,14 @@
+class UriComponentBuidler
+  def self.construct(path, params)
+    path = path.dup
+    path_params = path.split('/').select { |s| s.start_with?(':') }.map { |s| s[1..-1].to_sym }
+
+    path_params.each do |key|
+      raise ArgumentError, "#{key} should be passed in params" unless params[key]
+      path.sub!(":#{key}", params[key].to_s)
+      params.delete(key)
+    end
+
+    path.end_with?('/') ? path[0..-2] : path
+  end
+end

data/lib/squarespace_api/client.rb

@@ -0,0 +1,50 @@
+module SquarespaceApi
+  class Client
+    def initialize(config = nil)
+      @config = config || SquarespaceApi.config
+      @connection = Connection.new(@config)
+    end
+
+    %w(
+      orders
+      order_fulfillments
+      products
+      product_variants
+      product_images
+      product_variant_images
+      profiles
+      store_pages
+      inventory
+      inventory_adjustments
+      transactions
+      webhook_subscriptions
+      tokens
+    ).each do |resource|
+      define_method(resource) do
+        @connection.with_app_session do
+          return instance_variable_get(:"@_#{resource}") if instance_variable_get(:"@_#{resource}")
+          instance_variable_set(
+            :"@_#{resource}",
+            Module
+            .const_get("SquarespaceApi::ResourceGroups::#{resource.to_camelcase}")
+            .new(connection: @connection)
+          )
+        end
+      end
+    end
+
+   %w(website).each do |resource|
+      define_method(resource) do
+        @connection.with_app_session do
+          Module.const_get("SquarespaceApi::Resources::#{resource.to_camelcase}").new(connection: @connection).get
+        end
+      end
+    end
+
+    def build_oauth_authorize_url(params)
+      @config.oauth_base_url +
+        '/authorize?' +
+        { client_id: @config.client_id }.merge(params).map { |k, v| "#{k}=#{v}" }.join('&')
+    end
+  end
+end

data/lib/squarespace_api/config.rb

@@ -0,0 +1,27 @@
+module SquarespaceApi
+  class Config
+    STABLE_VERSION = '1.0'.freeze
+    attr_accessor :client_id, :client_secret,
+      :api_version, :access_token,
+      :base_url
+
+    def initialize(options = {})
+      @api_version   = options[:api_version] || STABLE_VERSION
+      @access_token  = options[:access_token]
+      @client_id     = options[:client_id] || ENV['SQUARESPACE_CLIENT_ID']
+      @client_secret = options[:client_secret] || ENV['SQUARESPACE_CLIENT_SECRET']
+    end
+
+    def base_url
+      "https://api.squarespace.com".freeze
+    end
+
+    def oauth_base_url
+      "https://login.squarespace.com/api/1/login/oauth/provider".freeze
+    end
+
+    def encoded_oauth_token
+      Base64.strict_encode64("#{client_id}:#{client_secret}").to_s
+    end
+  end
+end

data/lib/squarespace_api/connection.rb

@@ -0,0 +1,110 @@
+require 'securerandom'
+require "faraday"
+require 'faraday_middleware'
+require "json"
+
+module SquarespaceApi
+  class Connection
+    DEFAULT_HEADERS = {
+      'Content-Type' => 'application/json',
+      'User-Agent' => 'SquarespaceApi'
+    }.freeze
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+      @connection = Faraday.new do |connection|
+        connection.headers = DEFAULT_HEADERS
+        connection.response :json
+      end
+
+      initialize_app_session if config.access_token
+    end
+
+    def get(path, params: {}, headers: {})
+      handle_response(connection.get(path, params, connection.headers.merge(headers)))
+    end
+
+    def post(path, params: {}, headers: {})
+      handle_response(connection.post(path, params, connection.headers.merge(headers)))
+    end
+
+    def delete(path, params: {}, headers: {})
+      handle_response(connection.delete(path, params, connection.headers.merge(headers)))
+    end
+
+    def upload_file(path, file_path)
+      temp_connection = Faraday.new(url: api_base_url) do |f|
+        f.request :multipart
+        f.response :json
+        f.headers = DEFAULT_HEADERS.merge(
+          'Authorization' => "Bearer #{config.access_token}",
+          'Content-Type' => 'multipart/form-data',
+        )
+      end.post(path, { file: Faraday::FilePart.new(file_path, 'text/x-ruby') })
+    end
+
+    def with_idempotency_key
+      @connection.headers['Idempotency-Key'] = SecureRandom.hex
+      yield
+    end
+
+    def with_app_session
+      initialize_app_session
+      yield
+    end
+
+    def initialize_app_session
+      @connection.headers['Authorization'] = "Bearer #{config.access_token}"
+      @connection.url_prefix = api_base_url
+      self
+    end
+
+    def with_oauth_session
+      initialize_oauth_session
+      yield
+    end
+
+    def initialize_oauth_session
+      @connection.headers['Authorization'] = "Basic #{config.encoded_oauth_token}"
+      @connection.url_prefix = config.oauth_base_url
+      self
+    end
+
+    private
+
+    attr_reader :connection
+
+    def api_base_url
+      "#{config.base_url}/#{config.api_version}"
+    end
+
+    def handle_response(response)
+      return response if response.success?
+      error_message = response.body.dig('message')
+      case response.status
+      when 400
+        raise SquarespaceApi::Errors::BadRequest, error_message
+      when 401
+        raise SquarespaceApi::Errors::Unauthorized, error_message
+      when 404
+        raise SquarespaceApi::Errors::NotFound, error_message
+      when 405
+        raise SquarespaceApi::Errors::MethodNotAllowed, error_message
+      when 429
+        raise SquarespaceApi::Errors::TooManyRequests, error_message
+      else
+        response
+      end
+    end
+  end
+
+  module Errors
+    class BadRequest < StandardError; end
+    class Unauthorized < StandardError; end
+    class NotFound < StandardError; end
+    class MethodNotAllowed < StandardError; end
+    class TooManyRequests < StandardError; end
+  end
+end

data/lib/squarespace_api/paginated_fetch.rb

@@ -0,0 +1,13 @@
+module SquarespaceApi
+  module PaginatedFetch
+    def self.build(params = {}, &_block)
+      loop do
+        response = yield(params)
+
+        has_next_page = response.dig('pagination', 'hasNextPage').to_s == 'true'
+        break unless has_next_page
+        params = { cursor:  response.dig('pagination', 'nextPageCursor') }
+      end
+    end
+  end
+end

data/lib/squarespace_api/resource.rb

@@ -0,0 +1,19 @@
+module SquarespaceApi
+  class Resource
+    def initialize(connection:)
+      @connection = connection
+    end
+
+    def resource_path
+      self.class::PATH
+    end
+
+    def get
+      connection.get(resource_path).body
+    end
+
+    protected
+
+    attr_reader :connection
+  end
+end

data/lib/squarespace_api/resource_group.rb

@@ -0,0 +1,35 @@
+module SquarespaceApi
+  class ResourceGroup
+    def initialize(connection:)
+      @connection = connection
+    end
+
+    protected
+
+    attr_reader :connection, :resource, :resource_path
+
+    def resource_path
+      resources_path + "/:id"
+    end
+
+    def resources_path
+      self.class::PATH
+    end
+
+    def parse(response)
+      response.body || true
+    end
+
+    def parse_collection
+      raise 'This method should be implemented in a subclass.'
+    end
+
+    class << self
+      def allowed_actions(*args)
+        args.each do |action|
+          self.send(:include, Module.const_get("SquarespaceApi::ResourceGroupActions::#{action.to_s.to_camelcase}"))
+        end
+      end
+    end
+  end
+end

data/lib/squarespace_api/resource_group_actions.rb

@@ -0,0 +1,70 @@
+require 'squarespace_api/paginated_fetch'
+require 'helper/uri_component_builder'
+
+module SquarespaceApi
+  module ResourceGroupActions
+    module All
+      def all(params = {}, &_block)
+        PaginatedFetch.build(params) do |paginated_params|
+          response = parse_collection(
+            connection
+            .get(UriComponentBuidler.construct(resources_path, paginated_params), params: paginated_params)
+          )
+          return response unless block_given?
+          yield(response)
+          response
+        end
+      end
+
+      alias_method :where, :all
+    end
+
+    module Find
+      def find(id, params = {})
+        parse(
+          connection
+          .get(UriComponentBuidler.construct(resource_path, params.merge(id: id)))
+        )
+      end
+    end
+
+    module FindByIds
+      def find_by_ids(ids = [])
+        parse_collection(
+          connection
+          .get(UriComponentBuidler.construct(resource_path, { id: ids.join(",") }))
+        )
+      end
+    end
+
+    module Create
+      def create(params = {})
+        connection.with_idempotency_key do
+          parse(
+            connection
+            .post(UriComponentBuidler.construct(resources_path, params), params: params.to_json)
+          )
+        end
+      end
+    end
+
+    module Update
+      def update(id, params = {})
+        params = params.merge(id: id)
+        parse(
+          connection
+          .post(UriComponentBuidler.construct(resource_path, params), params: params.to_json)
+        )
+      end
+    end
+
+    module Delete
+      def delete(id, params = {})
+        parse(
+          connection
+          .delete(UriComponentBuidler.construct(resource_path, params.merge(id: id)))
+        )
+      end
+    end
+  end
+end