squarespace_api 0.0.4

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "webmock/rspec"
+require "pry"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require 'squarespace_api'
+require 'json'
+
+RSpec.configure do |config|
+end

data/spec/squarespace_api/client_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe SquarespaceApi::Client do
+  let(:access_token) { "test_token" }
+  let(:config) { SquarespaceApi::Config.new(access_token: access_token, client_id: 'your_client_id') }
+  let(:client) { described_class.new(config) }
+
+
+  describe "resource_groups methods" do
+    it '#orders' do
+      expect(client.orders).to be_a SquarespaceApi::ResourceGroups::Orders
+    end
+
+    it '#order_fulfillments' do
+      expect(client.order_fulfillments).to be_a SquarespaceApi::ResourceGroups::OrderFulfillments
+    end
+
+    it '#products' do
+      expect(client.products).to be_a SquarespaceApi::ResourceGroups::Products
+    end
+
+    it '#product_variants' do
+      expect(client.product_variants).to be_a SquarespaceApi::ResourceGroups::ProductVariants
+    end
+
+    it '#product_images' do
+      expect(client.product_images).to be_a SquarespaceApi::ResourceGroups::ProductImages
+    end
+
+    it '#product_variant_images' do
+      expect(client.product_variant_images).to be_a SquarespaceApi::ResourceGroups::ProductVariantImages
+    end
+
+    it '#inventory' do
+      expect(client.inventory).to be_a SquarespaceApi::ResourceGroups::Inventory
+    end
+
+    it '#inventory_adjustments' do
+      expect(client.inventory_adjustments).to be_a SquarespaceApi::ResourceGroups::InventoryAdjustments
+    end
+
+    it '#profiles' do
+      expect(client.profiles).to be_a SquarespaceApi::ResourceGroups::Profiles
+    end
+
+    it '#store_pages' do
+      expect(client.store_pages).to be_a SquarespaceApi::ResourceGroups::StorePages
+    end
+
+    it '#transactions' do
+      expect(client.transactions).to be_a SquarespaceApi::ResourceGroups::Transactions
+    end
+
+    it '#webhook_subscriptions' do
+      expect(client.webhook_subscriptions).to be_a SquarespaceApi::ResourceGroups::WebhookSubscriptions
+    end
+
+    it '#tokens' do
+      expect(client.tokens).to be_a SquarespaceApi::ResourceGroups::Tokens
+    end
+  end
+
+  describe "#resources methods" do
+    it '#website' do
+      expect_any_instance_of(SquarespaceApi::Resources::Website).to receive(:get)
+      client.website
+    end
+  end
+
+  describe '#build_oauth_authorize_url' do
+    it 'should construct correct url' do
+      expect(client.build_oauth_authorize_url(
+        redirect_url: 'https://api.test.com/squarespace',
+        scope: 'website.orders,website.orders.read',
+        state: '1234',
+        access_type: "offline"
+      )).to eq('https://login.squarespace.com/api/1/login/oauth/provider/authorize?client_id=your_client_id&redirect_url=https://api.test.com/squarespace&scope=website.orders,website.orders.read&state=1234&access_type=offline')
+    end
+  end
+end

data/spec/squarespace_api/config_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe SquarespaceApi::Config do
+  let(:config) do
+    described_class.new(
+      client_id: 'test_client_id',
+      client_secret: 'test_client_secret',
+      access_token: 'test_access_token'
+    )
+  end
+
+  it 'has an client_id' do
+    expect(config.client_id).to eq('test_client_id')
+  end
+
+  it 'has an client_secret' do
+    expect(config.client_secret).to eq('test_client_secret')
+  end
+
+  it 'has an access_token' do
+    expect(config.access_token).to eq('test_access_token')
+  end
+end

data/spec/squarespace_api/connection_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe SquarespaceApi::Connection do
+  let(:config) { SquarespaceApi::Config.new( access_token: 'test_access_token') }
+  let(:connection) { described_class.new(config) }
+
+  describe "#request" do
+    before do
+      stub_request(:get, "https://api.squarespace.com")
+        .to_return(status: status_code, body: body.to_json, headers: { "Content-Type" => "application/json" })
+    end
+
+    let(:status_code) { 200 }
+    let(:body) { { "result" => {} } }
+    it "should send http request" do
+      connection.get('https://api.squarespace.com')
+      expect(a_request(:get, "https://api.squarespace.com")).to have_been_made
+    end
+
+    context "when request fails" do
+      let(:status_code) { 401 }
+      let(:body) { { message: "Unauthorized" } }
+      it "should raise error" do
+        expect {
+          connection.get('https://api.squarespace.com')
+        }.to raise_error(SquarespaceApi::Errors::Unauthorized, "Unauthorized")
+      end
+    end
+  end
+
+  describe "#with_app_session" do
+    before do
+      stub_request(:get, "https://api.squarespace.com/1.0/commerce/orders")
+        .to_return(status: 200, body: {}.to_json, headers: { "Content-Type" => "application/json" })
+    end
+
+    it "should send http request" do
+      connection.with_app_session { connection.get('commerce/orders') }
+
+      expect(a_request(:get, "https://api.squarespace.com/1.0/commerce/orders")
+        .with(headers: {Authorization: "Bearer test_access_token"})).to have_been_made
+    end
+  end
+
+  describe "#with_oauth_session" do
+    before do
+      stub_request(:get, "https://login.squarespace.com/api/1/login/oauth/provider/token")
+        .to_return(status: 200, body: {}.to_json, headers: { "Content-Type" => "application/json" })
+    end
+
+    it "should send http request" do
+      connection.with_oauth_session { connection.get('token') }
+
+      expect(a_request(:get, "https://login.squarespace.com/api/1/login/oauth/provider/token")
+        .with(headers: {Authorization: "Basic Og=="})).to have_been_made
+    end
+  end
+end

data/spec/squarespace_api/resource_group_actions_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'squarespace_api/resource_group'
+
+class DummyResrouce < SquarespaceApi::ResourceGroup
+  PATH = 'commerce/dummy'.freeze
+  allowed_actions :all, :find, :find_by_ids, :create, :delete, :update
+
+  def parse_collection(response)
+    response.body['dummy']
+  end
+end
+
+describe SquarespaceApi::ResourceGroupActions do
+  let(:connection) { SquarespaceApi::Connection.new(SquarespaceApi::Config.new).initialize_app_session }
+  let(:resource) { DummyResrouce.new(connection: connection) }
+
+  describe '#all' do
+    before do
+      stub_request(:get, "https://api.squarespace.com/1.0/commerce/dummy?status=pending")
+        .to_return(status: 200, body: { 'dummy' => [] }.to_json)
+    end
+
+    it { expect(resource.all(status: 'pending')).to eq([]) }
+    it { expect(resource.where(status: 'pending')).to eq([]) }
+  end
+
+  describe '#find' do
+    before do
+      stub_request(:get, "https://api.squarespace.com/1.0/commerce/dummy/123")
+        .to_return(status: 200, body: { id: 123 }.to_json)
+    end
+
+    it { expect(resource.find(123)).to eq("id" => 123) }
+  end
+
+  describe '#find_by_ids' do
+    before do
+      stub_request(:get, "https://api.squarespace.com/1.0/commerce/dummy/1,2,3")
+        .to_return(status: 200, body: { 'dummy' => [] }.to_json)
+    end
+
+    it { expect(resource.find_by_ids([1, 2, 3])).to eq([]) }
+  end
+
+  describe '#create' do
+    before do
+      stub_request(:post, "https://api.squarespace.com/1.0/commerce/dummy")
+        .to_return(status: 200)
+    end
+
+    it { expect(resource.create(some_data: 'data')).to eq(true) }
+  end
+
+  describe '#update' do
+    before do
+      stub_request(:post, "https://api.squarespace.com/1.0/commerce/dummy/123")
+        .to_return(status: 200, body: { update_data: 'test data' }.to_json)
+    end
+
+    it { expect(resource.update(123, update_data: 1)).to eq('update_data' => 'test data') }
+  end
+
+  describe '#delete' do
+    before do
+      stub_request(:delete, "https://api.squarespace.com/1.0/commerce/dummy/123")
+        .to_return(status: 200)
+    end
+
+    it { expect(resource.delete(123)).to eq(true) }
+  end
+end

data/spec/squarespace_api/resource_groups/orders_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe SquarespaceApi::ResourceGroups::Orders do
+  let(:access_token) { "test_token" }
+  let(:config) { SquarespaceApi::Config.new(access_token: access_token) }
+  let(:connection) { SquarespaceApi::Connection.new(config).initialize_app_session }
+  let(:orders_api) { described_class.new(connection: connection) }
+
+  describe "fulfil" do
+    before { stub_request(:post, "https://api.squarespace.com/1.0/commerce/orders/123/fulfillments") }
+
+    it "should send correct request" do
+      orders_api.fulfil('123', { 'shouldSendNotification' => false })
+      expect(a_request(:post, "https://api.squarespace.com/1.0/commerce/orders/123/fulfillments")
+        .with(body: { shouldSendNotification: false }.to_json)).to have_been_made
+    end
+  end
+end

data/spec/squarespace_api/resource_groups/product_images_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe SquarespaceApi::ResourceGroups::ProductImages do
+  let(:connection) { SquarespaceApi::Connection.new(SquarespaceApi::Config.new).initialize_app_session }
+  let(:api) { described_class.new(connection: connection) }
+
+  describe "#status" do
+    before { stub_request(:get, "https://api.squarespace.com/1.0/commerce/products/1/images/1/status") }
+
+    it "should send correct request" do
+      api.status(1, { product_id: '1' })
+      expect(a_request(:get, "https://api.squarespace.com/1.0/commerce/products/1/images/1/status")).to have_been_made
+    end
+  end
+
+  describe "#reorder" do
+    before { stub_request(:post, "https://api.squarespace.com/1.0/commerce/products/1/images/1/order") }
+
+    it "should send correct request" do
+      api.order(1, { product_id: '1', afterImageId: '2' })
+      expect(a_request(:post, "https://api.squarespace.com/1.0/commerce/products/1/images/1/order")
+        .with(body: { 'afterImageId' => '2' }.to_json)).to have_been_made
+    end
+  end
+end

data/spec/squarespace_api/resource_groups/tokens_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe SquarespaceApi::ResourceGroups::Tokens do
+  let(:connection) { SquarespaceApi::Connection.new(SquarespaceApi::Config.new).initialize_app_session }
+  let(:api) { described_class.new(connection: connection) }
+
+  let(:token_response) do
+    {
+      "token" => "T1|Rr0Wc95uu3cSeBh06yB...",
+      "token_type" => "bearer",
+      "access_token" => "T1|Rr0Wc95uu3cSeBh06yB...",
+      "access_token_expires_at" => "1553532363.542",
+      "refresh_token" => "1|KYUYh35zcwzx4Zt/oty3...",
+      "refresh_token_expires_at" => "1554135363.542"
+    }
+  end
+
+  describe "#create" do
+    before do
+      stub_request(:post, "https://login.squarespace.com/api/1/login/oauth/provider/tokens")
+        .with(headers: { 'Authorization'=>'Basic Og==' })
+        .and_return(status: 200, body: token_response.to_json)
+    end
+
+    it "should get expected response" do
+      expect(api.create(
+        refresh_token: 'some_refresh_token',
+        grant_type: "refresh_token"
+      )).to eq(token_response)
+    end
+  end
+end

data/spec/squarespace_api/resource_groups/webhook_subscriptions_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe SquarespaceApi::ResourceGroups::WebhookSubscriptions do
+  let(:connection) { SquarespaceApi::Connection.new(SquarespaceApi::Config.new).initialize_app_session }
+  let(:api) { described_class.new(connection: connection) }
+
+  describe "#send_test_notification" do
+    before do
+      stub_request(:post, "https://api.squarespace.com/1.0/webhook_subscriptions/1/actions/sendTestNotification")
+        .with(body: { topic: 'extension.uninstall' }.to_json)
+        .and_return(status: 200)
+    end
+
+    it "should send correct request" do
+      expect(api.send_test_notification(1, { topic: 'extension.uninstall' })).to eq(true)
+    end
+  end
+
+  describe "#rotate_secret" do
+    before do
+      stub_request(:post, "https://api.squarespace.com/1.0/webhook_subscriptions/1/actions/rotateSecret")
+        .and_return(status: 200, body: { 'secret' => 'test_secret' }.to_json)
+    end
+
+    it "should send correct request" do
+      expect(api.rotate_secret(1)).to eq('secret' => 'test_secret')
+    end
+  end
+end

data/spec/squarespace_api/resource_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+class Dummy < SquarespaceApi::Resource
+  PATH = 'commerce/dummy'
+end
+
+describe SquarespaceApi::Resource do
+  let(:connection) { SquarespaceApi::Connection.new(SquarespaceApi::Config.new).initialize_app_session }
+  let(:resource) { Dummy.new(connection: connection) }
+
+  describe '#get' do
+    before do
+      stub_request(:get, "https://api.squarespace.com/1.0/commerce/dummy")
+        .to_return(status: 200, body: { 'name': 'dummy'  }.to_json)
+    end
+
+    it { expect(resource.get).to eq('name' => 'dummy') }
+  end
+end

data/spec/squarespace_api_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe SquarespaceApi do
+  it 'has a version number' do
+    expect(SquarespaceApi::VERSION).to eq('0.0.4')
+  end
+
+  context 'configure' do
+    SquarespaceApi.configure do |config|
+      config.access_token = 'access_token'
+      config.client_id = 'client_id'
+      config.client_secret = 'client_secret'
+    end
+
+    it 'should configure' do
+      expect(SquarespaceApi.config.access_token).to eq('access_token')
+      expect(SquarespaceApi.config.client_id).to eq('client_id')
+      expect(SquarespaceApi.config.client_secret).to eq('client_secret')
+    end
+  end
+end

data/squarespace_api.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name        = "squarespace_api"
+  spec.version     = "0.0.4"
+  spec.summary     = "Ruby gem interacting with the Squarespace API."
+  spec.description = "Ruby gem interacting with the Squarespace API."
+  spec.authors     = ["cdragon"]
+  spec.email       = "cdragon1116@gmail.com"
+  spec.homepage    = "https://github.com/cdragon1116/squarespace_api"
+  spec.license     = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "json"
+  spec.add_dependency "yaml"
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: squarespace_api
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- cdragon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem interacting with the Squarespace API.
+email: cdragon1116@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/helper/string.rb
+- lib/helper/uri_component_builder.rb
+- lib/squarespace_api.rb
+- lib/squarespace_api/client.rb
+- lib/squarespace_api/config.rb
+- lib/squarespace_api/connection.rb
+- lib/squarespace_api/paginated_fetch.rb
+- lib/squarespace_api/resource.rb
+- lib/squarespace_api/resource_group.rb
+- lib/squarespace_api/resource_group_actions.rb
+- lib/squarespace_api/resource_groups/inventory.rb
+- lib/squarespace_api/resource_groups/inventory_adjustments.rb
+- lib/squarespace_api/resource_groups/order_fulfillments.rb
+- lib/squarespace_api/resource_groups/orders.rb
+- lib/squarespace_api/resource_groups/product_images.rb
+- lib/squarespace_api/resource_groups/product_variant_images.rb
+- lib/squarespace_api/resource_groups/product_variants.rb
+- lib/squarespace_api/resource_groups/products.rb
+- lib/squarespace_api/resource_groups/profiles.rb
+- lib/squarespace_api/resource_groups/store_pages.rb
+- lib/squarespace_api/resource_groups/tokens.rb
+- lib/squarespace_api/resource_groups/transactions.rb
+- lib/squarespace_api/resource_groups/webhook_subscriptions.rb
+- lib/squarespace_api/resources/website.rb
+- lib/squarespace_api/version.rb
+- spec/fixtures/order_response.json
+- spec/fixtures/orders_response.json
+- spec/spec_helper.rb
+- spec/squarespace_api/client_spec.rb
+- spec/squarespace_api/config_spec.rb
+- spec/squarespace_api/connection_spec.rb
+- spec/squarespace_api/resource_group_actions_spec.rb
+- spec/squarespace_api/resource_groups/orders_spec.rb
+- spec/squarespace_api/resource_groups/product_images_spec.rb
+- spec/squarespace_api/resource_groups/tokens_spec.rb
+- spec/squarespace_api/resource_groups/webhook_subscriptions_spec.rb
+- spec/squarespace_api/resource_spec.rb
+- spec/squarespace_api_spec.rb
+- squarespace_api.gemspec
+homepage: https://github.com/cdragon1116/squarespace_api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Ruby gem interacting with the Squarespace API.
+test_files:
+- spec/fixtures/order_response.json
+- spec/fixtures/orders_response.json
+- spec/spec_helper.rb
+- spec/squarespace_api/client_spec.rb
+- spec/squarespace_api/config_spec.rb
+- spec/squarespace_api/connection_spec.rb
+- spec/squarespace_api/resource_group_actions_spec.rb
+- spec/squarespace_api/resource_groups/orders_spec.rb
+- spec/squarespace_api/resource_groups/product_images_spec.rb
+- spec/squarespace_api/resource_groups/tokens_spec.rb
+- spec/squarespace_api/resource_groups/webhook_subscriptions_spec.rb
+- spec/squarespace_api/resource_spec.rb
+- spec/squarespace_api_spec.rb