falsify 0.1.0

data/lib/falsify/models/product/product.rb

@@ -0,0 +1,83 @@
+require "enumerize"
+
+module Falsify
+  # The Product resource lets you update and create products in a merchant's store.
+  # See the [API documentation](https://help.shopify.com/en/api/reference/products/product).
+  #
+  # Required Fields:
+  # - title
+  class Product
+    extend Enumerize
+    # A description of the product. Supports HTML formatting.
+    # @return [String]
+    attr_accessor :body_html
+    # The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the product was created.
+    # @return [String]
+    attr_reader :created_at
+    # A unique human-friendly string for the product.
+    # Automatically generated from the product's `title`.
+    # Used by the Liquid templating language to refer to objects.
+    # @return [String]
+    attr_accessor :handle
+    # An unsigned 64-bit integer that's used as a unique identifier for the product.
+    # Each `id` is unique across the Shopify system.
+    # No two products will have the same `id`, even if they're from different shops.
+    # @return [String]
+    attr_reader :id
+    # A list of [product image](https://help.shopify.com/en/api/reference/products/product-image) objects, each one representing an image associated with the product.
+    # @return [String]
+    attr_accessor :images
+    # The custom product property names like `Size`, `Color`, and `Material`.
+    # You can add up to 3 options of up to 255 characters each.
+    # @return [String]
+    attr_accessor :options
+    # A categorization for the product used for filtering and searching products.
+    # @return [String]
+    attr_accessor :product_type
+    # The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the product was published.
+    # Can be set to `null` to unpublish the product from the Online Store channel.
+    # @return [String]
+    attr_accessor :published_at
+    # @!attribute published_scope [rw]
+    #   Whether the product is published to the Point of Sale channel.
+    #   Valid values:
+    #   - `web`: The product is published to the Online Store channel but not published to the Point of Sale channel.
+    #   - `global`: The product is published to both the Online Store channel and the Point of Sale channel.
+    #   @return [:web, :global]
+    enumerize :published_scope, in: [:web, :global]
+    # A string of comma-separated tags that are used for filtering and search.
+    # A product can have up to 250 tags.
+    # Each tag can have up to 255 characters.
+    # @return [String]
+    attr_accessor :tags
+    # The suffix of the Liquid template used for the product page.
+    # If this property is specified, then the product page uses a template called "product.suffix.liquid", where "suffix" is the value of this property.
+    # If this property is `""` or `null`, then the product page uses the default template "product.liquid".
+    # (default: `null`)
+    # @return [String,nil]
+    attr_accessor :template_suffix
+    # The name of the product.
+    # @return [String]
+    attr_accessor :title
+    # The name of the product used for [SEO purposes](https://help.shopify.com/en/manual/promoting-marketing/seo#page-title).
+    # Generally added to the `<meta name='title'>` tag.
+    # @return [String]
+    attr_accessor :metafields_global_title_tag
+    # A description of the product used for [SEO purposes](https://help.shopify.com/en/manual/promoting-marketing/seo#meta-description).
+    # Generally added to the `<meta name='description'>` tag.
+    # @return [String]
+    attr_accessor :metafields_global_description_tag
+    # The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the product was last modified.
+    # @return [String]
+    attr_reader :updated_at
+    # A list of [product variants](/en/api/reference/products/product-variant), each representing a different version of the product.
+    # The `position` property is read-only.
+    # The position of variants is indicated by the order in which they are listed.
+    # To retrieve the `presentment_prices` property on a variant, include the request header `'X-Shopify-Api-Features': 'include-presentment-prices'`.
+    # @return [Array<ProductVariant>]
+    attr_accessor :variants
+    # The name of the product's vendor.
+    # @return [String]
+    attr_accessor :vendor
+  end
+end

data/lib/falsify/models/product/product_image.rb

@@ -0,0 +1,39 @@
+module Falsify
+  # See the [API documentation](https://help.shopify.com/en/api/reference/products/product-image).
+  # Any product may have up to 250 images, and images can be in .png, .gif or .jpg format.
+  class ProductImage
+    # The date and time when the product image was created.
+    # The API returns this value in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+    # @return [String]
+    attr_accessor :created_at
+    # A unique numeric identifier for the product image.
+    # @return [String]
+    attr_accessor :id
+    # The order of the product image in the list.
+    # The first product image is at position 1 and is the "main" image for the product.
+    # @return [Integer]
+    attr_accessor :position
+    # The id of the product associated with the image.
+    # @return [String]
+    attr_accessor :product_id
+    # An array of variant ids associated with the image.
+    # @return [Array<String>]
+    attr_accessor :variant_ids
+    # Specifies the location of the product image.
+    # This parameter supports [URL filters](https://help.shopify.com/themes/liquid/filters/url-filters#img_url) that you can use to retrieve modified copies of the image.
+    # For example, add `_small`, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, `ipod-nano_small.png`),
+    # or add `_2048x2048` to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, `ipod-nano_2048x2048.png`).
+    # @return [String]
+    attr_accessor :src
+    # Width dimension of the image which is determined on upload.
+    # @return [Integer]
+    attr_accessor :width
+    # Height dimension of the image which is determined on upload.
+    # @return [Integer]
+    attr_accessor :height
+    # The date and time when the product image was last modified.
+    # The API returns this value in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+    # @return [String]
+    attr_accessor :updated_at
+  end
+end

data/lib/falsify/models/product/product_variant.rb

@@ -0,0 +1,111 @@
+require "enumerize"
+
+module Falsify
+  # A variant can be added to a Product resource to represent one version of a product with several options.
+  #
+  # See the [API documentation](https://help.shopify.com/en/api/reference/products/product-variant).
+  class ProductVariant
+    extend Enumerize
+    # The barcode, UPC, or ISBN number for the product.
+    # @return [String]
+    attr_accessor :barcode
+    # The original price of the item before an adjustment or a sale.
+    # @return [String]
+    attr_accessor :compare_at_price
+    # The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the product variant was created.
+    # @return [String]
+    attr_accessor :created_at
+    # The fulfillment service associated with the product variant.
+    # Valid values: `manual` or the handle of a [fulfillment service](https://help.shopify.com/en/api/reference/shipping-and-fulfillment/fulfillmentservice).
+    # @return [String]
+    attr_accessor :fulfillment_service
+    # The weight of the product variant in grams.
+    # @return [String]
+    attr_accessor :grams
+    # The unique numeric identifier for the product variant.
+    # @return [String]
+    attr_accessor :id
+    # The unique numeric identifier for a product's image.
+    # The image must be associated to the same product as the variant.
+    # @return [String]
+    attr_accessor :image_id
+    # The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information.
+    # @return [String]
+    attr_accessor :inventory_item_id
+    # The fulfillment service that tracks the number of items in stock for the product variant.
+    # If you track the inventory yourself using the admin, then set the value to "shopify".
+    # Valid values: `shopify` or the handle of a [fulfillment service](https://help.shopify.com/en/api/reference/shipping-and-fulfillment/fulfillmentservice) that has inventory management enabled.
+    # Must be the same fulfillment service referenced by the `fulfillment_service` property.
+    # @return [String]
+    attr_accessor :inventory_management
+    # @!attribute inventory_policy [rw]
+    #   Whether customers are allowed to place an order for the product variant when it's out of stock.
+    #   Valid values:
+    #   - `deny` - Customers are not allowed to place orders for the product variant if it's out of stock.
+    #   - `continue` - Customers are allowed to place orders for the product variant if it's out of stock.
+    #   @return [:deny, :continue]
+    enumerize :inventory_policy, in: [:deny, :continue]
+    # An aggregate of inventory across all locations.
+    # To adjust inventory at a specific location, use the [InventoryLevel](https://help.shopify.com/en/api/reference/inventory/inventorylevel) resource.
+    # @return [String]
+    attr_reader :inventory_quantity
+    # @deprecated Use the [InventoryLevel](https://help.shopify.com/en/api/reference/inventory/inventorylevel) resource instead.
+    # @return [Integer]
+    attr_accessor :old_inventory_quantity
+    # @deprecated Use the [InventoryLevel](https://help.shopify.com/en/api/reference/inventory/inventorylevel) resource instead.
+    # @return [Integer]
+    attr_accessor :inventory_quantity_adjustment
+    # The custom properties that a shop owner uses to define product variants.
+    # You can define three options for a product: `option1`, `option2`, `option3`.
+    # Default value: `Default Title`.
+    # @return [String]
+    attr_accessor :option
+    # A list of the variant's presentment prices and compare-at prices in each of the shop's enabled presentment currencies.
+    # Each price object has the following properties:
+    # - `currency_code`: The three-letter code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format) for one of the shop's enabled presentment currencies.
+    # - `amount`: The variant's price or compare-at price in the presentment currency.
+    # @return [Array<String>]
+    attr_accessor :presentment_prices
+    # The order of the product variant in the list of product variants.
+    # The first position in the list is `1`.
+    # The position of variants is indicated by the order in which they are listed.
+    # @return [Integer]
+    attr_reader :position
+    # The price of the product variant.
+    # @return [String]
+    attr_accessor :price
+    # The unique numeric identifier for the product.
+    # @return [String]
+    attr_accessor :product_id
+    # Whether a customer needs to provide a shipping address when placing an order for the product variant.
+    # @return [Boolean]
+    attr_accessor :requires_shipping
+    # A unique identifier for the product variant in the shop.
+    # Required in order to connect to a [FulfillmentService](https://help.shopify.com/api/reference/fulfillmentservice).
+    # @return [Boolean]
+    attr_accessor :sku
+    # Whether a tax is charged when the product variant is sold.
+    # @return [Boolean]
+    attr_accessor :taxable
+    # This parameter applies only to the stores that have the [Avalara AvaTax](https://help.shopify.com/en/manual/taxes/tax-services/taxation) app installed.
+    # Specifies the Avalara tax code for the product variant.
+    # @return [String]
+    attr_accessor :tax_code
+    # The title of the product variant.
+    # @return [String]
+    attr_accessor :title
+    # The date and time when the product variant was last modified.
+    # Gets returned in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+    # @return [String]
+    attr_accessor :updated_at
+    # The weight of the product variant in the unit system specified with `weight_unit`.
+    # @return [String]
+    attr_accessor :weight
+    # @!attribute weight_unit [rw]
+    #   The unit of measurement that applies to the product variant's weight.
+    #   If you don't specify a value for `weight_unit`, then the shop's default unit of measurement is applied.
+    #   Valid values: `g`, `kg`, `oz`, and `lb`.
+    #   @return [:g, :kg, :oz, :lb]
+    enumerize :weight_unit, in: [:g, :kg, :oz, :lb]
+  end
+end

data/lib/falsify/version.rb

@@ -0,0 +1,3 @@
+module Falsify
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: falsify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clay Dunston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: enumerize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: Shopify resources (WIP)
+email:
+- dunstontc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/docs
+- bin/setup
+- falsify.gemspec
+- lib/falsify.rb
+- lib/falsify/error.rb
+- lib/falsify/models/address.rb
+- lib/falsify/models/customer/customer.rb
+- lib/falsify/models/customer/metafield.rb
+- lib/falsify/models/fulfillment/fulfillment.rb
+- lib/falsify/models/fulfillment/fulfillment_event.rb
+- lib/falsify/models/fulfillment/fulfillment_line_item.rb
+- lib/falsify/models/fulfillment/supported_tracking_companies.rb
+- lib/falsify/models/order/client_details.rb
+- lib/falsify/models/order/discount_allocation.rb
+- lib/falsify/models/order/discount_application.rb
+- lib/falsify/models/order/discount_code.rb
+- lib/falsify/models/order/order.rb
+- lib/falsify/models/order/order_line_item.rb
+- lib/falsify/models/order/price_set.rb
+- lib/falsify/models/order/refund/refund.rb
+- lib/falsify/models/order/refund/refund_line_item.rb
+- lib/falsify/models/order/shipping_line.rb
+- lib/falsify/models/order/tax_line.rb
+- lib/falsify/models/product/collection/collect.rb
+- lib/falsify/models/product/collection/custom_collection.rb
+- lib/falsify/models/product/collection/smart_collection.rb
+- lib/falsify/models/product/product.rb
+- lib/falsify/models/product/product_image.rb
+- lib/falsify/models/product/product_variant.rb
+- lib/falsify/version.rb
+homepage: https://github.com/tcd/falsify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tcd/falsify
+  source_code_uri: https://github.com/tcd/falsify
+  changelog_uri: https://github.com/tcd/falsify/blob/master/CHANGELOG.md
+  yard.run: yri
+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.3
+signing_key: 
+specification_version: 4
+summary: Shopify resources (WIP)
+test_files: []