woocommercerb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f7654089a34f24c6933243630226e58da26617e8022f5354622c51616df4d3c
+  data.tar.gz: 821bacc1a3ac46dd98c45eed3fc67e435023ac52f1f716566fe6d6e89bc0d82c
+SHA512:
+  metadata.gz: b9c911b990804c87b1877149d7cde1f9117037ded67c3b9b0f2b93b6fd1819e82844cf23c78610f0eb92203fe4d5043ae922aa24e26907ee98a62690f48563df
+  data.tar.gz: 4da457a6d06095edc6ed3a633cca039c9cfb953f99122f2a001580a7d75f92074083576eb050e90b3616c47753f1fe81c5efd58aa39e7213d278e2550991490e

data/.env.example

@@ -0,0 +1,3 @@
+URL=
+API_KEY=
+API_SECRET=

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in woocommerce.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    woocommercerb (0.1.0)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.1)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  rake (~> 13.0)
+  woocommercerb!
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dean Perry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# WooCommerceRB
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/woocommerce`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'woocommerce'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install woocommerce
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/woocommerce.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/woo_commerce/client.rb

@@ -0,0 +1,52 @@
+module WooCommerce
+  class Client
+
+    attr_reader :url, :api_key, :api_secret, :adapter
+
+    def initialize(url:, api_key:, api_secret:, adapter: Faraday.default_adapter, stubs: nil)
+      @url = url
+      @api_key = api_key
+      @api_secret = api_secret
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def coupons
+      CouponsResource.new(self)
+    end
+
+    def customers
+      CustomersResource.new(self)
+    end
+
+    def orders
+      OrdersResource.new(self)
+    end
+
+    def order_notes
+      OrderNotesResource.new(self)
+    end
+
+    def products
+      ProductsResource.new(self)
+    end
+
+    def product_categories
+      ProductCategoriesResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new("#{url}/wp-json/wc/v3") do |conn|
+        conn.request :authorization, :basic, api_key, api_secret
+        conn.request :json
+
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+  end
+end

data/lib/woo_commerce/collection.rb

@@ -0,0 +1,19 @@
+module WooCommerce
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:)
+      body = response.body
+
+      new(
+        data: body.map { |attrs| type.new(attrs) },
+        total: body.count,
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/woo_commerce/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module WooCommerce
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/woo_commerce/objects/coupon.rb

@@ -0,0 +1,4 @@
+module WooCommerce
+  class Coupon < Object
+  end
+end

data/lib/woo_commerce/objects/customer.rb

@@ -0,0 +1,4 @@
+module WooCommerce
+  class Customer < Object
+  end
+end

data/lib/woo_commerce/objects/order.rb

@@ -0,0 +1,4 @@
+module WooCommerce
+  class Order < Object
+  end
+end

data/lib/woo_commerce/objects/order_note.rb

@@ -0,0 +1,4 @@
+module WooCommerce
+  class OrderNote < Object
+  end
+end

data/lib/woo_commerce/objects/product.rb

@@ -0,0 +1,4 @@
+module WooCommerce
+  class Product < Object
+  end
+end

data/lib/woo_commerce/objects/product_category.rb

@@ -0,0 +1,4 @@
+module WooCommerce
+  class ProductCategory < Object
+  end
+end

data/lib/woo_commerce/resource.rb

@@ -0,0 +1,54 @@
+module WooCommerce
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["message"]}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action."
+      when 404
+        raise Error, "Error 404: No results were found for your request."
+      when 409
+        raise Error, "Error 409: Your request was a conflict."
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit."
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems."
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second."
+      end
+
+      response
+    end
+  end
+end

data/lib/woo_commerce/resources/coupons.rb

@@ -0,0 +1,28 @@
+module WooCommerce
+  class CouponsResource < Resource
+    
+    def list(**params)
+      response = get_request("coupons", params: params)
+      Collection.from_response(response, type: Coupon)
+    end
+
+    def retrieve(id:)
+      Coupon.new get_request("coupons/#{id}").body
+    end
+
+    def create(code:, discount_type:, amount:, **params)
+      attributes = {code: code, discount_type: discount_type, amount: amount.to_s}
+      Coupon.new post_request("coupons", body: attributes.merge(params)).body
+    end
+
+    def update(id:, **params)
+      Coupon.new put_request("coupons/#{id}", body: params).body
+    end
+
+    def delete(id:)
+      response = delete_request("coupons/#{id}", params: {force: true})
+      return true if response.success?
+    end
+
+  end
+end

data/lib/woo_commerce/resources/customers.rb

@@ -0,0 +1,28 @@
+module WooCommerce
+  class CustomersResource < Resource
+    
+    def list(**params)
+      response = get_request("customers", params: params)
+      Collection.from_response(response, type: Customer)
+    end
+
+    def retrieve(id:)
+      Customer.new get_request("customers/#{id}").body
+    end
+
+    def create(email:, **params)
+      attributes = {email: email}
+      Customer.new post_request("customers", body: attributes.merge(params)).body
+    end
+
+    def update(id:, **params)
+      Customer.new put_request("customers/#{id}", body: params).body
+    end
+
+    def delete(id:)
+      response = delete_request("customers/#{id}", params: {force: true})
+      return true if response.success?
+    end
+
+  end
+end

data/lib/woo_commerce/resources/order_notes.rb

@@ -0,0 +1,28 @@
+module WooCommerce
+  class OrderNotesResource < Resource
+    
+    def list(order:, **params)
+      response = get_request("orders/#{order}/notes", params: params)
+      Collection.from_response(response, type: OrderNote)
+    end
+
+    def retrieve(order:, id:)
+      OrderNote.new get_request("orders/#{order}/notes/#{id}").body
+    end
+
+    def create(order:, note:, **params)
+      attributes = {note: note}
+      OrderNote.new post_request("orders/#{order}/notes", body: attributes.merge(params)).body
+    end
+
+    def update(order:, id:, **params)
+      OrderNote.new put_request("orders/#{order}/notes/#{id}", body: params).body
+    end
+
+    def delete(order:, id:)
+      response = delete_request("orders/#{order}/notes/#{id}", params: {force: true})
+      return true if response.success?
+    end
+
+  end
+end

data/lib/woo_commerce/resources/orders.rb

@@ -0,0 +1,27 @@
+module WooCommerce
+  class OrdersResource < Resource
+    
+    def list(**params)
+      response = get_request("orders", params: params)
+      Collection.from_response(response, type: Order)
+    end
+
+    def retrieve(id:)
+      Order.new get_request("orders/#{id}").body
+    end
+
+    def create(**params)
+      Order.new post_request("orders", body: params).body
+    end
+
+    def update(id:, **params)
+      Order.new put_request("orders/#{id}", body: params).body
+    end
+
+    def delete(id:)
+      response = delete_request("orders/#{id}", params: {force: true})
+      return true if response.success?
+    end
+
+  end
+end

data/lib/woo_commerce/resources/product_categories.rb

@@ -0,0 +1,28 @@
+module WooCommerce
+  class ProductCategoriesResource < Resource
+    
+    def list(**params)
+      response = get_request("products/categories", params: params)
+      Collection.from_response(response, type: ProductCategory)
+    end
+
+    def retrieve(id:)
+      ProductCategory.new get_request("products/categories/#{id}").body
+    end
+
+    def create(name:, **params)
+      attributes = {name: name}
+      ProductCategory.new post_request("products/categories", body: attributes.merge(params)).body
+    end
+
+    def update(id:, **params)
+      ProductCategory.new put_request("products/categories/#{id}", body: params).body
+    end
+
+    def delete(id:)
+      response = delete_request("products/categories/#{id}", params: {force: true})
+      return true if response.success?
+    end
+
+  end
+end

data/lib/woo_commerce/resources/products.rb

@@ -0,0 +1,28 @@
+module WooCommerce
+  class ProductsResource < Resource
+    
+    def list(**params)
+      response = get_request("products", params: params)
+      Collection.from_response(response, type: Product)
+    end
+
+    def retrieve(id:)
+      Product.new get_request("products/#{id}").body
+    end
+
+    def create(name:, **params)
+      attributes = {name: name}
+      Product.new post_request("products", body: attributes.merge(params)).body
+    end
+
+    def update(id:, **params)
+      Product.new put_request("products/#{id}", body: params).body
+    end
+
+    def delete(id:)
+      response = delete_request("products/#{id}", params: {force: true})
+      return true if response.success?
+    end
+
+  end
+end

data/lib/woo_commerce/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WooCommerce
+  VERSION = "0.1.0"
+end

data/lib/woo_commerce.rb

@@ -0,0 +1,27 @@
+require "faraday"
+require "json"
+require_relative "woo_commerce/version"
+
+module WooCommerce
+  class Error < StandardError; end
+
+  autoload :Client, "woo_commerce/client"
+  autoload :Collection, "woo_commerce/collection"
+  autoload :Resource, "woo_commerce/resource"
+  autoload :Object, "woo_commerce/object"
+
+  autoload :CouponsResource, "woo_commerce/resources/coupons"
+  autoload :CustomersResource, "woo_commerce/resources/customers"
+  autoload :OrdersResource, "woo_commerce/resources/orders"
+  autoload :OrderNotesResource, "woo_commerce/resources/order_notes"
+  autoload :ProductsResource, "woo_commerce/resources/products"
+  autoload :ProductCategoriesResource, "woo_commerce/resources/product_categories"
+
+  autoload :Coupon, "woo_commerce/objects/coupon"
+  autoload :Customer, "woo_commerce/objects/customer"
+  autoload :Order, "woo_commerce/objects/order"
+  autoload :OrderNote, "woo_commerce/objects/order_note"
+  autoload :Product, "woo_commerce/objects/product"
+  autoload :ProductCategory, "woo_commerce/objects/product_category"
+
+end

data/lib/woocommercerb.rb

@@ -0,0 +1 @@
+require "woo_commerce"

data/sig/woocommerce.rbs

@@ -0,0 +1,4 @@
+module Woocommerce
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/woocommercerb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/woo_commerce/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "woocommercerb"
+  spec.version = WooCommerce::VERSION
+  spec.authors = ["Dean Perry"]
+  spec.email = ["dean@deanpcmad.com"]
+
+  spec.summary = "Ruby Library for interacting with WooCommerce V3 APIs"
+  spec.description = spec.summary
+  spec.homepage = "https://deanpcmad.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/woocommercerb"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: woocommercerb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby Library for interacting with WooCommerce V3 APIs
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/woo_commerce.rb
+- lib/woo_commerce/client.rb
+- lib/woo_commerce/collection.rb
+- lib/woo_commerce/object.rb
+- lib/woo_commerce/objects/coupon.rb
+- lib/woo_commerce/objects/customer.rb
+- lib/woo_commerce/objects/order.rb
+- lib/woo_commerce/objects/order_note.rb
+- lib/woo_commerce/objects/product.rb
+- lib/woo_commerce/objects/product_category.rb
+- lib/woo_commerce/resource.rb
+- lib/woo_commerce/resources/coupons.rb
+- lib/woo_commerce/resources/customers.rb
+- lib/woo_commerce/resources/order_notes.rb
+- lib/woo_commerce/resources/orders.rb
+- lib/woo_commerce/resources/product_categories.rb
+- lib/woo_commerce/resources/products.rb
+- lib/woo_commerce/version.rb
+- lib/woocommercerb.rb
+- sig/woocommerce.rbs
+- woocommercerb.gemspec
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/woocommercerb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Ruby Library for interacting with WooCommerce V3 APIs
+test_files: []