falsify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 020ab0a1975ef2077d0cf69093b94027e9369c61e966424eb715d843993147b5
+  data.tar.gz: d2847d7dccf9e329b40c275dc050507ce8d698c584dddfd31e2dc6461d9ac503
+SHA512:
+  metadata.gz: 8e0198b4fd9c23097692322ed110a2a3f9b939c0ed3658012e21c0a841ddadfb46733319aa615ffcf39ddb2cdee24319a63dff7e5d7559bdba32069168ebf25f
+  data.tar.gz: b6d7106ab3315b03671570d01defd09876302f6d971ab2a3e7cb730a30a6036c52b52fc5c949d2fedc929cf1803ebbbb9c5bd71c74319b80435f7b6b2f22a2f7

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode
+/vendor/
+
+.env
+.rake_tasks

data/.rubocop.yml

@@ -0,0 +1,123 @@
+AllCops:
+  TargetRubyVersion: 2.6.0
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/DocumentationMethod:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+# Don't leave calls to pry lying around.
+Lint/Debugger:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 150
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+# Only use braces if the function expects a hash argument. [different in Ruby 2.7+](https://blog.saeloun.com/2019/10/07/ruby-2-7-keyword-arguments-redesign.html)
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+# https://unix.stackexchange.com/a/18789
+Layout/TrailingBlankLines:
+  EnforcedStyle: final_newline
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+# Explicit, not redundant
+Style/RedundantReturn:
+  Enabled: false
+
+# Explicit, not redundant
+Style/RedundantSelf:
+  Enabled: false
+
+# Use of `&` with bracket access isn't what I'd call "readable".
+Style/SafeNavigation:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# TODO: File issue to ignore ternary statements when using `EnforcedStyle: assign_inside_condition`.
+Style/ConditionalAssignment:
+  # EnforcedStyle: assign_inside_condition
+  # EnforcedStyle: assign_to_condition
+  Enabled: false
+
+Lint/HandleExceptions:
+  AllowComments: true
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: False
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1,2 @@
+--charset utf-8
+--markup markdown

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+## 0.1.0 (2019-11-25)
+
+### Added
+
+- Classes modeling the following resources:
+    - Address
+    - Customer
+    - Metafield
+    - Fulfillment
+    - Fulfillment Event
+    - Fulfillment Line Item
+    - Supported Tracking Companies
+    - Client Details
+    - Discount Allocation
+    - Discount Application
+    - Discount Code
+    - Order
+    - Order Line Item
+    - Price Set
+    - Refund
+    - Refund Line Item
+    - Shipping Line
+    - Tax Line
+    - Product
+    - Product Image
+    - Product Variant
+    - Collect
+    - Custom Collection
+    - Smart Collection

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in falsify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    falsify (0.1.0)
+      enumerize (~> 2.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ansi (1.5.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.3.2)
+    enumerize (2.2.2)
+      activesupport (>= 3.2)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    minitest-focus (1.1.2)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tins (1.22.2)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls (~> 0.8.23)
+  falsify!
+  minitest (~> 5.8)
+  minitest-focus (~> 1.1)
+  minitest-reporters (~> 1.4)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  simplecov
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Clay Dunston
+
+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,44 @@
+# Falsify
+
+![Shopify API Version](https://img.shields.io/badge/Shopify_API-2019--10-brightgreen.svg)
+[![Build Status](https://travis-ci.org/tcd/falsify.svg?branch=master)](https://travis-ci.org/tcd/falsify)
+[![Coverage Status](https://coveralls.io/repos/github/tcd/falsify/badge.svg?branch=master)](https://coveralls.io/github/tcd/falsify?branch=master)
+[![Inline docs](http://inch-ci.org/github/tcd/falsify.svg?branch=master)](http://inch-ci.org/github/tcd/falsify)
+[![Documentation](http://img.shields.io/badge/docs-rubydoc.org-blue.svg)](https://rubydoc.org/github/tcd/falsify/master)
+
+Models for Shopify resources (WIP).
+
+Can be used with the [shopify_api gem](https://github.com/Shopify/shopify_api), which doesn't itself provide any documentation on the resources it wraps.
+
+Also has methods that use [faker](https://github.com/faker-ruby/faker) to generate fake Shopify data.
+Could be useful to for populating product, customer, order, etc. data for a development store to test against.
+
+Enum values are represented using [enumerize](https://github.com/brainspec/enumerize), so they will work without Rails,
+but are also compatible with [ActiveRecord enums](https://api.rubyonrails.org/v6.0.0/classes/ActiveRecord/Enum.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'falsify'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+Or install it yourself as:
+
+```sh
+gem install falsify
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tcd/falsify.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "falsify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/docs

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+# Rebuild project documentation and serve it locally.
+rm -rf .yardoc && yard server -r

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/falsify.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "falsify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "falsify"
+  spec.version       = Falsify::VERSION
+  spec.authors       = ["Clay Dunston"]
+  spec.email         = ["dunstontc@gmail.com"]
+  spec.summary       = "Shopify resources (WIP)"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/tcd/falsify"
+  spec.license       = "MIT"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "https://github.com/tcd/falsify/blob/master/CHANGELOG.md",
+    "yard.run" => "yri", # use "yard" to build full HTML docs.
+  }
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.23"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "minitest-focus", "~> 1.1"
+  spec.add_development_dependency "minitest-reporters", "~> 1.4"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_runtime_dependency "enumerize", "~> 2.2.2" # Issue filed regarding 2.3 - https://github.com/brainspec/enumerize/issues/352
+end

data/lib/falsify.rb

@@ -0,0 +1,4 @@
+# Shopify resources.
+module Falsify; end
+
+Dir.glob(File.join(__dir__, "falsify", "/**/*.rb")).sort.each { |file| require file }

data/lib/falsify/error.rb

@@ -0,0 +1,5 @@
+module Falsify
+  # Exceptions raised by Falsify inherit from Error.
+  # @abstract
+  class Error < StandardError; end
+end

data/lib/falsify/models/address.rb

@@ -0,0 +1,54 @@
+module Falsify
+  # Used for:
+  # - Order.billing_address
+  # - Order.shipping_address
+  # - Customer.addresses
+  # - Customer.default_address
+  class Address
+    # The street address of the billing address.
+    # @return [String]
+    attr_accessor :address1
+    # An optional additional field for the street address of the billing address.
+    # @return [String]
+    attr_accessor :address2
+    # The city, town, or village of the billing address.
+    # @return [String]
+    attr_accessor :city
+    # The company of the person associated with the billing address.
+    # @return [String]
+    attr_accessor :company
+    # The name of the country of the billing address.
+    # @return [String]
+    attr_accessor :country
+    # The two-letter code ([ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format) for the country of the billing address.
+    # @return [String]
+    attr_reader :country_code
+    # The first name of the person associated with the payment method.
+    # @return [String]
+    attr_accessor :first_name
+    # The last name of the person associated with the payment method.
+    # @return [String]
+    attr_accessor :last_name
+    # The latitude of the billing address.
+    # @return [String]
+    attr_accessor :latitude
+    # The longitude of the billing address.
+    # @return [String]
+    attr_accessor :longitude
+    # The full name of the person associated with the payment method.
+    # @return [String]
+    attr_accessor :name
+    # The phone number at the billing address.
+    # @return [String]
+    attr_accessor :phone
+    # The name of the region (province, state, prefecture, ...) of the billing address.
+    # @return [String]
+    attr_accessor :province
+    # The two-letter abbreviation of the region of the billing address.
+    # @return [String]
+    attr_accessor :province_code
+    # The postal code (zip, postcode, Eircode, ...) of the billing address.
+    # @return [String]
+    attr_accessor :zip
+  end
+end