dear_inventory 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5de01e56315ab3e8fdab17da4ac986c6a0e8a28cea8ca4f12c6d3fe9d72d4b2b
+  data.tar.gz: fa31df63741d89de3b94f23ecd4de85e6de934dffc65dbcdebf41bf8469776be
+SHA512:
+  metadata.gz: c49a7abd36e48c1f3bbe90e39343db5468737f70f5b626b061234e728981308b16fe236fc8168daf49a415b90f2f8c98354b7990db8aea3c5062bad2b712649e
+  data.tar.gz: fbb67a2d10e7a6fb7f4145babe1d6b7a50e2625c7d50140c250f48a7972c803a852eaa5905539c4f16f9f90f109fc80789382593fac241094454fcab8f71c205

data/.env.example

@@ -0,0 +1,2 @@
+ACCOUNT_ID="abcdef01-2345-6789-abcd-ef0123456789"
+KEY="abcdef01-2345-6789-abcd-ef0123456789"

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.env
+/.ruby-version
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/tmp/
+
+# Specs
+.rspec_status
+/spec/reports/
+/spec/examples.txt

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--fail-fast
+--format documentation
+--profile
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,84 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - bin/**/*
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/EndAlignment:
+  AutoCorrect: true
+  EnforcedStyleAlignWith: variable
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - dear_inventory.gemspec
+    - spec/**/*
+
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/FilePath:
+  Enabled: false
+
+Security/Eval:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/Send:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

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/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 development@hashnotadam.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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dear_inventory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Adam Rice
+
+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,69 @@
+# DearInventory
+
+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/dear_inventory`. 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 "dear_inventory"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dear_inventory
+
+## Usage
+
+Before you begin, you will need to setup API credentials in DEAR Inventory at
+https://inventory.dearsystems.com/ExternalApi
+
+Next you need to supply your API credentials:
+```ruby
+require "dear_inventory"
+
+DearInventory.configure do |config|
+  config.account_id = "account_id"
+  config.key = "key"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+Since it is necessary to authenticate with DEAR Inventory to test API resources,
+credentials are required. The dotenv gem is loaded when tests are run and will
+look for a .env file in the root directory. A .env.example file has been
+supplied so you copy it to .env and replace the example values:
+
+```sh
+cp .env.example .env
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HashNotAdam/dear_inventory. 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 DearInventory project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/HashNotAdam/dear_inventory/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dear_inventory"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/dear_inventory.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dear_inventory/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dear_inventory"
+  spec.version = DearInventory::VERSION
+  spec.authors = ["Adam Rice"]
+  spec.email = ["development@hashnotadam.com"]
+
+  spec.summary = "Library for connecting to the DEAR Inventory API"
+  spec.description = "Works with V2 of the DEAR Systems / DEAR Inventory " \
+                     "API as seen at https://dearinventory.docs.apiary.io/"
+  spec.homepage = "https://morningcoffee.com.au"
+  spec.license = "MIT"
+
+  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_rubygems_version = ">= 1.8.11"
+
+  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_dependency "http", ">= 4.0.0", "< 5.0"
+  spec.add_dependency "sorbet-runtime"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.71"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "sorbet"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/lib/dear_inventory.rb

@@ -0,0 +1,79 @@
+# typed: strong
+# frozen_string_literal: true
+
+require "http"
+require "sorbet-runtime"
+
+require "dear_inventory/config"
+require "dear_inventory/environment"
+
+require "dear_inventory/error"
+require "dear_inventory/errors/request"
+require "dear_inventory/errors/validation"
+
+require "dear_inventory/lib/endpoint_class"
+require "dear_inventory/lib/is_a_subclass"
+
+require "dear_inventory/model"
+require "dear_inventory/models/additional_attributes"
+require "dear_inventory/models/additional_charge"
+require "dear_inventory/models/address"
+require "dear_inventory/models/attachment"
+require "dear_inventory/models/inventory_movement"
+require "dear_inventory/models/sale_list"
+require "dear_inventory/models/sales/line"
+require "dear_inventory/models/sales/invoice_line"
+require "dear_inventory/models/sales/manual_journal_line"
+require "dear_inventory/models/sales/manual_journal"
+require "dear_inventory/models/sales/order"
+require "dear_inventory/models/sales/payment_line"
+require "dear_inventory/models/sales/quote"
+require "dear_inventory/models/shipping_address"
+require "dear_inventory/models/transaction"
+require "dear_inventory/models/sales/fulfilments/pick_pack_line"
+require "dear_inventory/models/sales/fulfilments/pick_pack"
+require "dear_inventory/models/sales/fulfilments/ship_line"
+require "dear_inventory/models/sales/fulfilments/ship"
+require "dear_inventory/models/sales/fulfilment"
+require "dear_inventory/models/sale_lists"
+require "dear_inventory/models/sales/credit_note"
+require "dear_inventory/models/sales/invoice"
+require "dear_inventory/models/sale"
+
+require "dear_inventory/validator"
+require "dear_inventory/validators/boolean"
+require "dear_inventory/validators/enum"
+require "dear_inventory/validators/integer"
+require "dear_inventory/validators/required"
+require "dear_inventory/validators/string"
+require "dear_inventory/validators/time"
+
+require "dear_inventory/parameters"
+require "dear_inventory/parameters/sale/index"
+require "dear_inventory/parameters/sale_list/index"
+
+require "dear_inventory/resource"
+require "dear_inventory/resources/sale"
+require "dear_inventory/resources/sale_list"
+
+require "dear_inventory/response"
+
+require "dear_inventory/version"
+
+module DearInventory
+  extend T::Sig
+
+  @config = T.let(Config.new, Config)
+
+  class << self
+    extend T::Sig
+
+    sig { returns(Config) }
+    attr_reader :config
+
+    sig { params(block: T.proc.params(config: Config).void).void }
+    def configure(&block)
+      yield config
+    end
+  end
+end