squarespace_api 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc908a714e0fa1658267c8753adcbd9085e87bd2b0b46a108231e06b53a20f6b
-  data.tar.gz: 18a4ba216bc82ab428b5ee8c7352f4f8a23d9ab98630f6a469961860242a8871
+  metadata.gz: 7605a851dda2e468747c0133620edb3763d8961c935ca15b005e3a4b406fefa7
+  data.tar.gz: 1fb57f3e5cd318a7f3d0167927ee58521d3b76ecdd24ee5ea25daa408d2bb8e0
 SHA512:
-  metadata.gz: b2f62e190db5adc017b6d47933fc0e5fe28e10199098c1f148a1f4d2a10b7e5ec7efc95392f6afc22a2a53844d893733e1c815abba7d42135744332593640189
-  data.tar.gz: 73283ff1f0f272f39b3cd46c8db5651ae8316539663276f6225b0608c2304a637c02e37fd9d529fb300b33e1436a3f874a871cd014db148ce4d339b0d377999a
+  metadata.gz: 334a4961dc1130524e539ae650ac7cb7697fadad88fa1509aa08b0b765e9d31683690b49ab7d5b9a03728e4b1832e5b46acdfaa66d1d9fc9129baaf77e578f5d
+  data.tar.gz: 3205784829d70dd252340dd7fa620066a380703a84f73be2f036b303d616b3b59886ce301bb8791ffc45afae6f101de4075672ff089e54a1c8da16573b7873d4

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    squarespace_api (0.0.3)
+    squarespace_api (0.0.7)
       faraday
       faraday_middleware
       json
-      yaml
 
 GEM
   remote: https://rubygems.org/
@@ -16,29 +15,33 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    faraday (1.7.0)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       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-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
     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-retry (1.0.3)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
-    json (2.5.1)
+    json (2.6.1)
     method_source (1.0.0)
     multipart-post (2.1.1)
     pry (0.14.1)
@@ -64,7 +67,6 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yaml (0.1.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,3 +1,231 @@
 # Squarespace Api
 
-Ruby interface to the Squarespace API
+[![Gem Version](https://badge.fury.io/rb/squarespace_api.svg)](https://rubygems.org/gems/squarespace_api)
+
+
+Ruby interface to the [Squarespace API](https://developers.squarespace.com/commerce-apis/overview).
+
+## Installation
+
+Available in RubyGems.
+
+```bash
+$ gem install 'squarespace_api'
+```
+
+Add to your Gem file
+```ruby
+gem 'squarespace_api'
+```
+
+
+
+## Quick Example
+
+- Thread Safety Usage
+
+```ruby
+require 'squarespace_api'
+
+client = SquarespaceApi::Client.new(
+  SquarespaceApi::Config.new(
+    access_token: 'your access token'
+  )
+)
+
+# get one page of order
+client.orders.all
+=> [<SquarespaceOrderHash>, ...]
+
+
+# get every page of orders with filter
+orders = []
+orders = client.orders.all(fulfillmentStatus: 'PENDING') do |orders_per_page|
+  orders += orders_per_page
+  # or do something
+end
+
+# get website
+client.website
+```
+
+
+## ResourceGroups
+
+- [Orders](https://developers.squarespace.com/commerce-apis/orders-overview)
+
+```ruby
+# get one page
+client.orders.all(fulfillmentStatus: 'PENDING')
+
+# get all pages
+orders = []
+orders = client.orders.all(fulfillmentStatus: 'PENDING') do |orders_per_page|
+  orders += orders_per_page
+  # or do something
+end
+
+# find an order
+client.orders.find(id)
+
+# create an order
+client.orders.create(params)
+
+# fulfill an order
+client.orders.fulfil(id, params)
+```
+
+- [Products](https://developers.squarespace.com/commerce-apis/products-overview)
+
+```ruby
+client.products.all
+client.products.create(params)
+client.products.where(id: id)
+client.products.find(id)
+client.products.find_by_ids([id_1, id_2])
+client.products.update(id, params)
+client.products.delete(id)
+```
+
+- ProductImages
+
+```ruby
+# Noted that Path parameters should be passed in params.
+client.product_images.upload(file_path, { product_id: product_id })
+client.product_images.status(id, { product_id: product_id })
+client.product_images.order(id, { product_id: product_id, afterImageId: 'otherImageId' })
+client.product_images.update(id, { product_id: product_id, altText: 'my_picture' })
+```
+
+- ProductVariants
+
+```ruby
+# Noted that Path parameters should be passed in params.
+client.product_variants.create({ product_id: product_id })
+client.product_variants.update(id, { sku: 'P1234', product_id: product_id })
+```
+
+
+- ProductVarantImages
+
+```ruby
+# Noted that Path parameters should be passed in body params.
+client.product_variant_images.create({ imageId: image_id, product_id: product_id, variant_id: variant_id })
+```
+
+- Inventory
+
+```ruby
+client.inventory.all
+client.inventory.find(id)
+client.inventory_adjustments.create(params)
+```
+
+- Profiles
+
+```ruby
+client.profiles.all
+client.profiles.find(id)
+client.profiles.create(params)
+```
+
+- StorePages
+
+```ruby
+client.store_pages.all
+```
+
+- Transactions
+
+```ruby
+client.transactions.all
+client.transactions.find(id)
+client.transactions.find_by_ids([id_1, id_2])
+```
+
+- WebhookSubscriptions
+
+```ruby
+client.webhook_subscriptions.all
+client.webhook_subscriptions.find(id)
+client.webhook_subscriptions.create(id)
+client.webhook_subscriptions.update(id, params)
+client.webhook_subscriptions.delete(id)
+client.webhook_subscriptions.send_test_notification(id, params)
+client.webhook_subscriptions.rotate_secret(id)
+```
+
+
+## Single Resource
+
+- Website
+
+```ruby
+client.website
+```
+
+## Oauth App
+
+### Configuration
+
+configure your oauth cerdentials in ENV:
+
+```ruby
+# Auto load ENV
+SQUARESPACE_CLIENT_ID = 'your client id'
+SQUARESPACE_CLIENT_SECRET = 'your client secret'
+```
+
+Or configure in your initializer:
+
+```ruby
+SquarespaceApi.configure do |c|
+  c.client_id = 'your client id'
+  c.client_secret = 'your client secret'
+end
+```
+
+If you have multiple apps, consider thread safe usage:
+
+```ruby
+client = SquarespaceApi::Client.new(
+  SquarespaceApi::Config.new(
+    client_id: 'your client id',
+    client_secret: 'your client secret'
+  )
+)
+```
+
+### Oauth Actions
+
+- Construct Oauth Url
+
+```ruby
+SquarespaceApi::Client.new.build_oauth_authorize_url(
+  redirect_url: 'https://api.test.com/squarespace',
+  scope: 'website.orders,website.orders.read',
+  state: '1234',
+  access_type: "offline"
+)
+
+=> 'https://login.squarespace.com/api/1/login/oauth/provider/authorize?client_id=&redirect_url=https://api.test.com/squarespace&scope=website.orders,website.orders.read&state=1234&access_type=offline'
+```
+
+- Request Access Token
+
+```ruby
+# request access token
+client.tokens.create(
+  code: 'code sent from Squaerspace',
+  redirect_uri: "your redirect uri"
+)
+```
+
+- Request Refresh Token
+
+```ruby
+client.tokens.create(
+  refresh_token: 'some_refresh_token',
+  grant_type: "refresh_token"
+)
+```

data/lib/squarespace_api/connection.rb

@@ -17,6 +17,7 @@ module SquarespaceApi
       @connection = Faraday.new do |connection|
         connection.headers = DEFAULT_HEADERS
         connection.response :json
+        connection.adapter(Faraday.default_adapter)
       end
 
       initialize_app_session if config.access_token

data/lib/squarespace_api/paginated_fetch.rb

@@ -2,11 +2,11 @@ module SquarespaceApi
   module PaginatedFetch
     def self.build(params = {}, &_block)
       loop do
-        response = yield(params)
+        pagination = yield(params)
 
-        has_next_page = response.dig('pagination', 'hasNextPage').to_s == 'true'
-        break unless has_next_page
-        params = { cursor:  response.dig('pagination', 'nextPageCursor') }
+        has_next_page = !!pagination&.dig('hasNextPage')
+        break if not has_next_page
+        params = { cursor:  pagination['nextPageCursor'] }
       end
     end
   end

data/lib/squarespace_api/resource_group.rb

@@ -24,6 +24,10 @@ module SquarespaceApi
       raise 'This method should be implemented in a subclass.'
     end
 
+    def parse_pagination(response)
+      response.body['pagination']
+    end
+
     class << self
       def allowed_actions(*args)
         args.each do |action|

data/lib/squarespace_api/resource_group_actions.rb

@@ -6,13 +6,14 @@ module SquarespaceApi
     module All
       def all(params = {}, &_block)
         PaginatedFetch.build(params) do |paginated_params|
-          response = parse_collection(
-            connection
+          query_result = connection
             .get(UriComponentBuidler.construct(resources_path, paginated_params), params: paginated_params)
-          )
+          response = parse_collection(query_result)
+          pagination = parse_pagination(query_result)
+
           return response unless block_given?
           yield(response)
-          response
+          pagination
         end
       end
 

data/lib/squarespace_api/version.rb

@@ -1,3 +1,3 @@
 module SquarespaceApi
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.7'.freeze
 end

data/spec/squarespace_api/resource_group_actions_spec.rb

@@ -22,6 +22,33 @@ describe SquarespaceApi::ResourceGroupActions do
 
     it { expect(resource.all(status: 'pending')).to eq([]) }
     it { expect(resource.where(status: 'pending')).to eq([]) }
+
+    context "when pagination exists" do
+      before do
+        stub_request(:get, "https://api.squarespace.com/1.0/commerce/dummy?status=pending")
+          .to_return(status: 200, body: {
+            'dummy' => [{ 'id' => 1 }],
+            'pagination' => { "hasNextPage" => true, 'nextPageCursor' => "cursor"
+            }
+          }.to_json)
+
+        stub_request(:get, "https://api.squarespace.com/1.0/commerce/dummy?cursor=cursor")
+          .to_return(status: 200, body: {
+            'dummy' => [{ 'id' => 2 }],
+            'pagination' => { "hasNextPage" => false }
+          }.to_json)
+      end
+
+      it "should return all orders" do
+        orders = []
+
+        resource.all(status: 'pending') do |new_orders|
+          orders += new_orders
+        end
+
+        expect(orders).to eq([{ 'id' => 1 }, { 'id' => 2 }])
+      end
+    end
   end
 
   describe '#find' do

data/spec/squarespace_api_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe SquarespaceApi do
   it 'has a version number' do
-    expect(SquarespaceApi::VERSION).to eq('0.0.4')
+    expect(SquarespaceApi::VERSION).to eq('0.0.7')
   end
 
   context 'configure' do

data/squarespace_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = "squarespace_api"
-  spec.version     = "0.0.4"
+  spec.version     = "0.0.7"
   spec.summary     = "Ruby gem interacting with the Squarespace API."
   spec.description = "Ruby gem interacting with the Squarespace API."
   spec.authors     = ["cdragon"]
@@ -18,5 +18,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday"
   spec.add_dependency "faraday_middleware"
   spec.add_dependency "json"
-  spec.add_dependency "yaml"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squarespace_api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - cdragon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !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: []
@@ -176,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Ruby gem interacting with the Squarespace API.