squarespace_api 0.0.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec9a53ddcf9c57427b52c4eb4f044fca901ec741be24d2bd7e031de3af2f66ec
-  data.tar.gz: db58f1b492dd50bd85902940708b7db51114046d81775ff0bc10c5f3181b3464
+  metadata.gz: e6f7788076ff9fc2ffa41413601382ca709667d5cb2465aefbd05210128b6ec6
+  data.tar.gz: 81368918852aa42b9ab819842c6ad71b58d45f2be0d7406a5e211a65a0ed984d
 SHA512:
-  metadata.gz: 3c2e561ca3bdffd2df058d31250ce5f4cd592e35dc2b7b89651aa95f3a6092411fed3c3c470cbf16a6c7854ae3a073bb15ca40392a235a991d70b1bd1f9744f3
-  data.tar.gz: 160c6527b3636a7abd207ccec9b28213ab644103369bb86094cfe7b6c15c3c316c743eac2b1972d2d0ae39a64b378f4da0862ce7dc8944655e520438ae43aacf
+  metadata.gz: 0c030599588c0537738d76341364d9f40ae1d3b88c35dd9f06c16e0eb77dad5330f897b0811bc1a176509bb66a6ff62472c4f923e55ca70d9fd035c889e5a98a
+  data.tar.gz: dca3f5ff58069a53c7484f5824e19e083ac88417c085913f033ae5e1de8171ea37bf5a3b390c2f4faac378958bcb17fc006dc7f2544a283a73f8929f60b4e697

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jenny610138@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    squarespace_api (0.0.5)
-      faraday
-      faraday_middleware
-      json
-      yaml
+    squarespace_api (1.0.1)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+      json (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
@@ -16,35 +15,40 @@ 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)
+    pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
+    rake (11.3.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -64,16 +68,16 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yaml (0.1.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  pry
-  rspec
+  pry (~> 0.13.1)
+  rake (~> 11.2)
+  rspec (~> 3.0)
   squarespace_api!
-  webmock
+  webmock (~> 3.14)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -1,3 +1,244 @@
 # Squarespace Api
 
-Ruby interface to the Squarespace API
+[![Gem Version](https://badge.fury.io/rb/squarespace_api.svg)](https://rubygems.org/gems/squarespace_api) ![Spec Status](https://app.travis-ci.com/cdragon1116/squarespace_api.svg?branch=master)
+
+
+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"
+)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cdragon1116/squarespace_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Squarespace API project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cdragon1116/squarespace_api/blob/master/CODE_OF_CONDUCT.md).
+

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.5'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

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.5')
+    expect(SquarespaceApi::VERSION).to eq('1.0.1')
   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.5"
+  spec.version     = "1.0.1"
   spec.summary     = "Ruby gem interacting with the Squarespace API."
   spec.description = "Ruby gem interacting with the Squarespace API."
   spec.authors     = ["cdragon"]
@@ -11,12 +11,14 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '>= 1.8.6'
 
-  spec.add_dependency "faraday"
-  spec.add_dependency "faraday_middleware"
-  spec.add_dependency "json"
-  spec.add_dependency "yaml"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", '~> 0.13.1'
+  spec.add_development_dependency "webmock", '~> 3.14'
+  spec.add_development_dependency 'rake', '~> 11.2'
+
+  spec.add_dependency "faraday", '~> 1.7'
+  spec.add_dependency "faraday_middleware", '~> 1.1'
+  spec.add_dependency "json", '~> 2.5'
 end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: squarespace_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.1
 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
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.14'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '11.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: yaml
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 description: Ruby gem interacting with the Squarespace API.
 email: cdragon1116@gmail.com
 executables: []
@@ -115,6 +115,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -143,6 +145,7 @@ files:
 - lib/squarespace_api/resource_groups/webhook_subscriptions.rb
 - lib/squarespace_api/resources/website.rb
 - lib/squarespace_api/version.rb
+- rakefile
 - spec/fixtures/order_response.json
 - spec/fixtures/orders_response.json
 - spec/spec_helper.rb
@@ -169,14 +172,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.10
 signing_key:
 specification_version: 4
 summary: Ruby gem interacting with the Squarespace API.