squarespace_api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec9a53ddcf9c57427b52c4eb4f044fca901ec741be24d2bd7e031de3af2f66ec
-  data.tar.gz: db58f1b492dd50bd85902940708b7db51114046d81775ff0bc10c5f3181b3464
+  metadata.gz: 32478872cc1df7eec10067615d90da41fde3f1c24a53b983822ab88aaca9028a
+  data.tar.gz: c78a46681870051cc0c7295ba6f2228ebbf6f282948b7535aa5293136c86fe6b
 SHA512:
-  metadata.gz: 3c2e561ca3bdffd2df058d31250ce5f4cd592e35dc2b7b89651aa95f3a6092411fed3c3c470cbf16a6c7854ae3a073bb15ca40392a235a991d70b1bd1f9744f3
-  data.tar.gz: 160c6527b3636a7abd207ccec9b28213ab644103369bb86094cfe7b6c15c3c316c743eac2b1972d2d0ae39a64b378f4da0862ce7dc8944655e520438ae43aacf
+  metadata.gz: 1869f4331c33bec1534947d105beeec2eca1188fc647b8577423c01bc7711d80736e43084a9bbd8426f7abeb87e2cb450a28ee19731e539ad160ab547801322e
+  data.tar.gz: 85f777a4903afe12e310d248519db56136d843813e516967bb77675ecee32df6857cb2ba90f55e7113f33da2061175da596a3fd1401bc7900692b3a6e291d11f

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    squarespace_api (0.0.5)
+    squarespace_api (0.0.6)
       faraday
       faraday_middleware
       json
-      yaml
 
 GEM
   remote: https://rubygems.org/
@@ -64,7 +63,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,211 @@
 # 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'
+```
+
+
+
+## Simple Example Usage
+
+- 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 body 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 body 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)
+```
+
+## Resource
+
+- Website
+
+```ruby
+client.website
+```
+
+##  Oauth App
+
+- ENV
+
+```ruby
+# Auto load ENV
+SQUARESPACE_CLIENT_ID = 'your client id'
+SQUARESPACE_CLIENT_SECRET = 'your client secret'
+```
+
+- Construct Oauth Url
+
+```ruby
+client.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
+client = SquarespaceApi::Client.new(
+  SquarespaceApi::Config.new(
+    # your can specifize application credentials if you have multiple apps
+    # otherwise it'll auto load env
+    client_id: 'your client id',
+    client_secret: 'your client secret'
+  )
+)
+
+# 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/version.rb

@@ -1,3 +1,3 @@
 module SquarespaceApi
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

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('0.0.6')
   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     = "0.0.6"
   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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: squarespace_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - cdragon
@@ -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: []