manifestly-client 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c2c2bbd1db592e25a2a2f60574fc12a752fb5da4f692ea0094ea37457860ef8
+  data.tar.gz: 055a7c6ac784cdf413bf18b60a92d7cbe677b1c6305160f8aef8176323a882ea
+SHA512:
+  metadata.gz: 619d5222939cb3df4fcd91bd610f3f42aea73e1eafeef0e06acc7f795b34ca39f0d5a445136d491932b0d18742c7abe42f3e0f80ec09865c1d9fa2b88eccfce2
+  data.tar.gz: 1c26add7a5839f3c47e7cf5b56ae212227190d98a6caf00d22bb3985fe4f4669ae33d2d588b52c9e504da2cca9678336ff0dcb7928a362f03ec3a47feb6ebb9d

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,12 @@
+### Steps to reproduce
+Tell us how to make it happen
+
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### System configuration
+**Operating System version**:
+**Ruby version**:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. This could include
+benchmarks, or other information.
+
+If you are updating any of the CHANGELOG files or are asked to update the
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
+
+Thanks for contributing to firespring/manifestly-ruby!

data/.gitignore

@@ -0,0 +1,4 @@
+coverage/
+Gemfile.lock
+.*DS_Store
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+-c
+-f d
+--profile

data/.rubocop.yml

@@ -0,0 +1,33 @@
+# This is the configuration used to check the rubocop source code.
+inherit_from: #{RUBOCOP_HOME}/config/default.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/**/*'
+
+MethodLength:
+  Max: 20
+
+LineLength:
+  Max: 150
+
+LeadingCommentSpace:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+cache: bundler
+rvm: 2.4
+script:
+  - bundle exec rspec spec/unit
+  - bundle exec rubocop
+deploy:
+  - provider: releases
+    api_key:
+      secure: xg82SFFS5Vd99DV6F+9O81Y1yQL/7VMPlSQOMWLY8ZNFkoUsimdKMqNFVuLx2quy7Ui1CtXS4SEb1bdLo+JmmV5Wlrzwjx37l+WMHz3znng3V3UiLnTKlyeKaXFr1meKaFFltdN/p2dTSPaMamw0sbFk+ZvdT1AelFT0lHIouans/WydTOCiUURZ4qrVAUbaC63dV5vWC+7Qo0F9wkRSrXdpbF82xxJF2bH1ZCLZrmAgFkVjSbGZAJReMcfAbZB6Y59J+dKiXF31ycH8upkkbp7VHyA7b0F1/RZKfEnJ3kOs5N1wPwQF32esCe5WSaziqWKgNUpXbYFcvFliTrYq52PbUiwc1BvJnWFLuIMqZe4Av0McmYcJ561b+hnCm6/cPuCrnuYajyoPArbI6ir5JUEgzRl3nSF+T/sQph7iMX1j4LnotgTFRO3Erm10oRA6Z8AEwMEIzW38WdGgEpBt7EaQZ4ANk2PNBF7UXpVM26SilJc+2YpROcVVpMPR+6WuMUSamuLGTNc5juMemnKGpeNWIkEL1x0weztuENvwJlwyDprRfzVjnHxgQAJEUrTf5alyKkbnPBa0iZoqF/vCDoaG5utvWG7ct91pJfWKbxZt7rYzNRYBGwR8dJbq/H8eXie70J5izzwqz5Nyk2nWPadnVg8onpWGg0OUWo/lffw=
+    file_glob: true
+    file: manifestly-client-*.gem
+    on:
+      tags: true
+      rvm: 2.4
+      repo: firespring/manifestly-ruby
+
+  - provider: rubygems
+    api_key:
+      secure: v/HaDZovJL1mK9PFzBLmU2+bxfshARySwYT2rLGZ5s8GMs8jY9hN58jw6EK2pMkv+L7pwI/pGr7e/619i8ASF32TgH3sBy7mpoHdymC7yi51F11AFW1iMdNx4M3M6A8pkrKWpADEmcvooj0eB2Xn9ymIBYE2WtddJ+aS/OXaVuvfChCZmIXQ7GWH1ZBGaZOQVmEaXnJxyriVnGZ4E+CQiFm4rLsxnQeDUMjWsh4/rhwSsOus8U6+PqX99oqYTieofGBCeyXupQ/4gOo5GLc3ii9DKdA+jhSb1M9FyoELdC2XJSLqJaW8rRP063fUF4JBguMWf3eMM/Uc9i6buwjsc8jthgjoCJRJeckxCeO9cBocH4gdxIcu/R/kudsMLxyNVq+z3/AWrvOAzUKtWbVwyJXoh2Wdhwz6QF1yxEqJiYdaabJmlJUCNP89fmEAtSZohALJGmKxSjEbUlgxti0nkoh2zL7zXIrU6Nhv/Qblgrf3hQ8FXMIHBJt40vZHbQ6A5Ts07SfTUrSFazEgYR+aOxWpg+D/jqvkHii/2j1+cotkEw6itKs+coxDoz0hO1CFPvdZGmT5Sh/9YIDUIUaz+UhMtUqgblK1pfLP78Y+OCq2wH9WM9oEbc453kg1yxcy2G9ylGEcbGGXXPq11C7/YNxq5yNXVJOX78rDLNkk2jU=
+    gem: manifestly-client
+    on:
+      tags: true
+      rvm: 2.4
+      repo: firespring/manifestly-ruby

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 [support@firespring.com](mailto:support@firespring.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Firespring Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [support@firespring.com](mailto:support@firespring.com).
+
+## How to contribute
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/firespring/manifestly-ruby/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/firespring/manifestly-ruby/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+#### **Did you write a patch that fixes a bug?**
+
+Pull requests are always appreciated.
+
+To get started contributing, fork and clone the repo:
+
+```
+git clone git@github.com:your-username/manifestly-ruby.git
+```
+
+Install development Gems:
+
+```
+bundle install
+```
+
+Make your code changes.
+
+Make sure that your changes do not break any existing tests:
+
+```
+rspec spec/unit
+```
+
+Pull requests **will not be accepted** for any additional functionality without adding accompanying tests. Moreover, the repository contains a configuration for [Rubocop](https://github.com/bbatsov/rubocop). Pull requests will also not be accepted that do not pass the rubocop style-check. To check this simply run:
+
+```
+rubocop
+```
+
+Open a new GitHub pull request for the patch.
+
+Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'factory_bot'
+  gem 'faker'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'simplecov'
+  gem 'webmock'
+end

data/LICENSE.txt

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+

data/README.md

@@ -0,0 +1,119 @@
+# Manifest.ly Ruby Client
+
+A Ruby client that enables quick and easy interactions with the Manifest.ly api.
+
+## Getting Started
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'manifestly-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install manifestly-client
+
+### Basic Usage
+
+You may begin using the entity methods after specifying the MANIFESTLY_API_KEY variable in the environment.
+```ruby
+require 'manifestly'
+
+ENV['MANIFESTLY_API_KEY'] = '<secret>'
+puts Manifestly::Entity::Workflow.list.inspect
+```
+
+### Workflow entity
+
+You may create a new workflow by passing a hash of data to the Workflow constructor and invoking the `create` method. Some internal fields (like `id`) will be injected back in to the object after it is created.
+```ruby
+data = {title: 'Test Workflow'}
+workflow = Manifestly::Entity::Workflow.new(data).create
+workflow.create
+```
+
+If you specify an `external_id` for a local reference, Manifest.ly will use an `upsert` methodology (if the workflow does not exist it will be created - otherwise it will be updated). This effectively means that create/update/save function identically for workflows.
+```ruby
+data = {title: 'Test Workflow with External Id', external_id: 'abc123'}
+workflow = Manifestly::Entity::Workflow.new(data).create
+
+workflow.title = "#{workflow.title} (updated)"
+workflow.create
+```
+
+You may delete a workflow if you specified an external_id when creating it.
+```ruby
+data = {title: 'Test Workflow Delete', external_id: 'def456'}
+workflow = Manifestly::Entity::Workflow.new(data).create
+workflow.delete
+```
+
+##### Workflow Steps entity
+
+Steps may be passed in when creating a workflow via the steps field.
+```ruby
+data = {title: 'Test Workflow with steps', external_id: 'ghi789', steps: [{title: 'Step One'}]}
+workflow = Manifestly::Entity::Workflow.new(data)
+workflow.create
+```
+
+### Checklist Run entity
+
+You may start a new checklist run by passing a hash of data to the ChecklistRun constructor and invoking the `create` method. You must include the internal id of an existing workflow as the checklist_id. Subsequent modifications of this checklist run or it's steps is only possible if you are listed as one of the users on the run.
+```ruby
+my_email_address = 'john.smith@foo.bar'
+my_user = Manifestly::Entity::User.list.find { |it| it.email == my_email_address }
+
+title = 'Test Workflow with steps'
+workflows = Manifestly::Entity::Workflow.list
+workflow = workflows.find { |it| it.title == title }
+
+data = {title: "Test Run", checklist_id: workflow.id, users: [my_user.id]}
+checklist_run = Manifestly::Entity::ChecklistRun.new(data).create
+```
+
+You may complete a checklist step by calling the corresponding method on the step object. Currently you must either be a participant on the run or assigned to the step in order to complete it.
+```ruby
+my_email_address = 'john.smith@foo.bar'
+my_user = Manifestly::Entity::User.list.find { |it| it.email == my_email_address }
+
+checklist = Manifestly::Entity::ChecklistRun.list(title: 'Test Run', status: :started).first
+step = checklist.steps.first
+
+step.assign(my_user.id)
+step.complete
+```
+
+## Supported Ruby Versions
+
+This library is currently supported on Ruby 2.4+.
+
+## Versioning
+
+This library follows [Semantic Versioning](http://semver.org/).
+
+## Contributing
+
+Contributions to this library are always welcome and highly encouraged.
+
+See [Contributing](CONTRIBUTING.md) for more information on how to get started.
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](CODE_OF_CONDUCT.md) for more information.
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is
+available in [LICENSE](LICENSE.txt).
+
+## Support
+
+Please [report bugs at the project on Github](https://github.com/firespring/manifestly-ruby/issues)
+
+See [Contributing](CONTRIBUTING.md) for more information on how to get started.

data/lib/manifestly.rb

@@ -0,0 +1,23 @@
+LIB_DIR = File.realpath(File.dirname(__FILE__))
+$LOAD_PATH.unshift(LIB_DIR)
+Dir["#{LIB_DIR}/**/*.rb"].sort.each { |file| require file.sub("#{LIB_DIR}/", '').chomp('.rb') }
+
+module Manifestly
+  module DayOfTheWeek
+    MONDAY = 'Monday'.freeze
+    TUESDAY = 'Tuesday'.freeze
+    WEDNESDAY = 'Wednesday'.freeze
+    THURSDAY = 'Thursday'.freeze
+    FRIDAY = 'Friday'.freeze
+    SATURDAY = 'Saturday'.freeze
+    SUNDAY = 'Sunday'.freeze
+    WEEKDAY = [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY].freeze
+    WEEKEND = [SATURDAY, SUNDAY].freeze
+  end
+
+  module Duration
+    MINUTES = 'minutes'.freeze
+    HOURS = 'hours'.freeze
+    DAYS = 'days'.freeze
+  end
+end

data/lib/manifestly/entity/base.rb

@@ -0,0 +1,60 @@
+module Manifestly
+  module Entity
+    class Base
+      @attributes = nil
+
+      def initialize(data = {})
+        invalids = data.keys - attributes
+        raise "The following invalid #{self.class} keys were found: #{invalids}" unless invalids.empty?
+
+        self.attributes = data
+      end
+
+      def attributes
+        self.class.attributes
+      end
+
+      def self.attributes
+        @attributes ||= []
+      end
+
+      def attributes=(attrs)
+        attrs.each { |k, v| send(:"#{k}=", v) }
+      end
+
+      def self.attr_accessor(*attrs)
+        attrs.each { |attr| attributes << attr }
+        super
+      end
+
+      def self.attr_reader(*attrs)
+        attrs.each { |attr| attributes << attr }
+        super
+      end
+
+      def self.invalid_method(*names)
+        names&.each { |name| define_method(name) { |*_, **_| raise 'invalid method' } }
+      end
+
+      def self.invalid_class_method(*names)
+        names&.each { |name| define_method(name) { |*_, **_| raise 'invalid method' } }
+      end
+
+      def to_h
+        {}.tap do |hsh|
+          attributes.each do |attr|
+            value = send(attr)
+            if value.is_a?(Array)
+              value = value.map do |it|
+                next it.to_h if it.is_a?(Manifestly::Entity::Base)
+
+                it
+              end
+            end
+            hsh[attr] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/manifestly/entity/checklist_run.rb

@@ -0,0 +1,46 @@
+require_relative 'endpoint'
+
+module Manifestly
+  module Entity
+    class ChecklistRun < Endpoint
+      attr_accessor :id
+      attr_accessor :account_id
+      attr_accessor :archive_url
+      attr_accessor :checklist_id
+      attr_accessor :checklist_title
+      attr_accessor :completed_at
+      attr_accessor :description
+      attr_accessor :detailed_title
+      attr_accessor :external_id
+      attr_accessor :late_at
+      attr_accessor :percent_completed
+      attr_accessor :started_at
+      attr_accessor :state
+      attr_accessor :summary
+      attr_accessor :tag_list
+      attr_accessor :title
+      attr_accessor :version
+      attr_accessor :hide_steps_from_external
+      attr_accessor :only_assigned_can_complete
+      attr_reader :users
+      attr_accessor :origin
+
+      def self.path
+        'runs'
+      end
+
+      def users=(values)
+        @users = Array(values).map do |it|
+          next it if it.is_a?(Integer)
+          next it[:id] if it.is_a?(Hash) && it[:id]
+
+          raise "invalid user value #{it}"
+        end
+      end
+
+      def steps
+        @steps ||= Manifestly::Entity::ChecklistStep.list(self)
+      end
+    end
+  end
+end

data/lib/manifestly/entity/checklist_step.rb

@@ -0,0 +1,111 @@
+require_relative 'endpoint'
+require 'date'
+
+module Manifestly
+  module Entity
+    class ChecklistStep < Endpoint
+      attr_accessor :id
+      attr_accessor :assignee_avatar_url
+      attr_accessor :assignee_id
+      attr_accessor :assignee_name
+      attr_accessor :assignee_user_id
+      attr_accessor :assignee_simple_display_name
+      attr_accessor :completed_at
+      attr_accessor :comments
+      attr_accessor :data
+      attr_accessor :description_with_links
+      attr_accessor :run_detailed_title
+      attr_reader :header_step
+      attr_accessor :late_at
+      attr_accessor :position
+      attr_accessor :run_id
+      attr_accessor :skipped
+      attr_accessor :title
+      attr_accessor :user_id
+      attr_accessor :user
+      attr_accessor :picture
+      attr_accessor :run_step_data_setting
+
+      invalid_method(:create)
+      invalid_class_method(:get)
+      invalid_method(:update)
+      invalid_method(:save)
+      invalid_method(:delete)
+
+      def initialize(run, data = {})
+        raise 'invalid checklist run' unless run.is_a?(ChecklistRun)
+
+        @parent = run
+        super(data)
+      end
+
+      # Header step needs to always be a boolean (even if not set)
+      def header_step # rubocop:disable DuplicateMethods
+        @header_step || false
+      end
+
+      # Always convert to a boolean
+      def header_step=(value)
+        @header_step = (value.to_s == 'true')
+      end
+
+      def self.path
+        'run_steps'
+      end
+
+      def self.list(run)
+        response = client.get("#{run.path}/#{run.id}/#{path}")
+        json_entities = JSON.parse(response[:body], symbolize_names: true)[path.to_sym]
+        json_entities.map { |it| new(run, it) }
+      end
+
+      def complete
+        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/complete")
+        @parent.instance_variable_set(:@steps, nil)
+        nil
+      end
+
+      def uncomplete
+        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/uncomplete")
+        @parent.instance_variable_set(:@steps, nil)
+        nil
+      end
+
+      def skip
+        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/skip")
+        @parent.instance_variable_set(:@steps, nil)
+        nil
+      end
+
+      def unskip
+        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/unskip")
+        @parent.instance_variable_set(:@steps, nil)
+        nil
+      end
+
+      def add_data(data)
+        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/data", params: {data: data})
+        @parent.instance_variable_set(:@steps, nil)
+        nil
+      end
+
+      def add_picture(base_64_encoded_picture_data)
+        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/picture", params: {picture: base_64_encoded_picture_data})
+        @parent.instance_variable_set(:@steps, nil)
+        nil
+      end
+
+      def add_comment(comment)
+        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/comments", params: {comment: comment})
+        @parent.instance_variable_set(:@steps, nil)
+        nil
+      end
+
+      def assign(user_id)
+        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/assign", params: {assignee_user_id: user_id})
+        @parent.instance_variable_set(:@steps, nil)
+        nil
+      end
+    end
+  end
+end

data/lib/manifestly/entity/endpoint.rb

@@ -0,0 +1,63 @@
+require_relative 'base'
+require 'json'
+
+module Manifestly
+  module Entity
+    class Endpoint < Base
+      @client = nil
+
+      def path
+        self.class.path
+      end
+
+      def self.path
+        raise 'Must override method'
+      end
+
+      def client
+        self.class.client
+      end
+
+      def self.client
+        @client ||= Manifestly::Client.new
+      end
+
+      def create
+        response = client.post(path, params: to_h)
+        json_entity = JSON.parse(response[:body], symbolize_names: true)[path.chomp('s').to_sym]
+        self.attributes = json_entity
+        self
+      end
+
+      def self.list(**params)
+        response = client.get(path, params: params)
+        json_entities = JSON.parse(response[:body], symbolize_names: true)[path.to_sym]
+        json_entities.map { |it| new(it) }
+      end
+
+      def self.get(id)
+        response = client.get("#{path}/#{id}")
+        json_entity = JSON.parse(response[:body], symbolize_names: true)[path.chomp('s').to_sym]
+        new(json_entity)
+      end
+
+      def update
+        client.post("#{path}/#{id}", params: to_h)
+        self
+      end
+
+      def save
+        if id
+          update
+        else
+          create
+        end
+      end
+
+      def delete
+        client.delete(path, params: {external_id: external_id})
+        nil
+      end
+    end
+  end
+end

data/lib/manifestly/entity/user.rb

@@ -0,0 +1,26 @@
+require_relative 'endpoint'
+
+module Manifestly
+  module Entity
+    class User < Endpoint
+      attr_accessor :id
+      attr_accessor :avatar_url
+      attr_accessor :email
+      attr_accessor :name
+      attr_accessor :simple_display_name
+      attr_accessor :username
+      attr_accessor :membership_id
+      attr_accessor :role
+
+      invalid_method(:create)
+      invalid_class_method(:get)
+      invalid_method(:update)
+      invalid_method(:save)
+      invalid_method(:delete)
+
+      def self.path
+        'users'
+      end
+    end
+  end
+end

data/lib/manifestly/entity/workflow.rb

@@ -0,0 +1,45 @@
+require_relative 'endpoint'
+
+module Manifestly
+  module Entity
+    class Workflow < Endpoint
+      attr_accessor :id
+      attr_accessor :account_id
+      attr_accessor :business_days
+      attr_accessor :description
+      attr_accessor :expected_duration
+      attr_accessor :expected_duration_units
+      attr_accessor :external_id
+      attr_accessor :hide_steps_from_external
+      attr_reader :steps
+      attr_reader :tag_list
+      attr_accessor :title
+
+      def self.path
+        'checklists'
+      end
+
+      # Workflows use an 'upsert' methodology so the create and update routes are shared.
+      # Lookups are done via the external_id you pass in
+      def update
+        create
+      end
+
+      def steps # rubocop:disable DuplicateMethods
+        return @steps if @steps
+
+        # If you are trying to get the steps on a workflow returned by the `list` functionality,
+        @steps = self.class.get(id).steps if id
+        @steps ||= []
+      end
+
+      def steps=(values)
+        @steps = Array(values).map { |it| WorkflowStep.new(self, it) }
+      end
+
+      def tag_list=(values)
+        @tag_list = Array(values).map(&:upcase)
+      end
+    end
+  end
+end

data/lib/manifestly/entity/workflow_step.rb

@@ -0,0 +1,40 @@
+require_relative 'endpoint'
+
+module Manifestly
+  module Entity
+    class WorkflowStep < Base
+      attr_accessor :id
+      attr_accessor :checklist_id
+      attr_accessor :position
+      attr_accessor :title
+      attr_accessor :description
+      attr_accessor :description_with_links
+      attr_accessor :created_at
+      attr_accessor :updated_at
+      attr_reader :header_step
+      attr_accessor :active
+      attr_accessor :original_id
+      attr_accessor :late_at_offset
+      attr_accessor :late_at_offset_units
+      attr_accessor :late_at_basis
+      attr_accessor :parent_step_id
+
+      def initialize(workflow, data = {})
+        raise 'invalid workflow' unless workflow.is_a?(Workflow)
+
+        @parent = workflow
+        super(data)
+      end
+
+      # Header step needs to always be a boolean (even if not set)
+      def header_step # rubocop:disable DuplicateMethods
+        @header_step || false
+      end
+
+      # Always convert to a boolean
+      def header_step=(value)
+        @header_step = (value.to_s == 'true')
+      end
+    end
+  end
+end

data/lib/manifestly/http/client.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+
+module Manifestly
+  class Client
+    DEFAULT_URL = 'https://manifest.ly/api'.freeze
+    DEFAULT_API_VERSION = 'v1'.freeze
+
+    attr_reader :url, :api_version, :api_key
+
+    def initialize(url: ENV['MANIFESTLY_URL'], api_version: ENV['MANIFESTLY_API_VERSION'], api_key: ENV['MANIFESTLY_API_KEY'])
+      @url = url || DEFAULT_URL
+      @api_version = api_version || DEFAULT_API_VERSION
+      @api_key = api_key || raise('api key is required')
+    end
+
+    def get(path, params: {}, headers: {})
+      handle_request { raw_get("#{url}/#{api_version}/#{path}", params: params, headers: headers) }
+    end
+
+    private def raw_get(path, params: {}, headers: {})
+      include_api_key!(params)
+      include_json_accept!(headers)
+      Faraday.get(path, params, headers)
+    end
+
+    def post(path, params: {}, headers: {})
+      handle_request { raw_post("#{url}/#{api_version}/#{path}", params: params, headers: headers) }
+    end
+
+    private def raw_post(path, params: {}, headers: {})
+      include_api_key!(params)
+      include_json_content_type!(headers)
+      include_json_accept!(headers)
+      Faraday.post(path, params.to_json, headers)
+    end
+
+    def delete(path, params: {}, headers: {})
+      handle_request { raw_delete("#{url}/#{api_version}/#{path}", params: params, headers: headers) }
+    end
+
+    private def raw_delete(path, params: {}, headers: {})
+      include_api_key!(params)
+      include_json_accept!(headers)
+      Faraday.delete(path, params, headers)
+    end
+
+    private def include_api_key!(params)
+      params.merge!(api_key: api_key)
+    end
+
+    private def include_json_content_type!(headers)
+      headers.merge!('Content-Type': 'application/json')
+    end
+
+    private def include_json_accept!(headers)
+      headers.merge!('Accept': 'application/json')
+    end
+
+    private def handle_request
+      short_response = trim_response(yield)
+      case short_response[:status]
+      when 404
+        raise Faraday::Error::ResourceNotFound, short_response
+      when 400...600
+        raise Faraday::Error::ClientError, short_response
+      end
+
+      short_response
+    end
+
+    private def trim_response(full_response)
+      {status: full_response.status, headers: full_response.headers, body: full_response.body}
+    end
+  end
+end

data/lib/manifestly/version.rb

@@ -0,0 +1,3 @@
+module Manifestly
+  VERSION = '0.0.0'.freeze
+end

data/manifestly-client.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift("#{__dir__}/lib")
+require 'manifestly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'manifestly-client'
+  spec.version       = Manifestly::VERSION
+  spec.licenses      = ['Apache-2.0']
+  spec.authors       = ['Firespring']
+  spec.email         = ['info.dev@firespring.com']
+
+  spec.homepage      = 'https://github.com/firespring/manifestly-ruby'
+  spec.summary       = 'Manifest.ly client library for ruby'
+  spec.description   = 'A Ruby client that enables quick and easy interactions with the Manifest.ly api'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: manifestly-client
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Firespring
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: A Ruby client that enables quick and easy interactions with the Manifest.ly
+  api
+email:
+- info.dev@firespring.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/manifestly.rb
+- lib/manifestly/entity/base.rb
+- lib/manifestly/entity/checklist_run.rb
+- lib/manifestly/entity/checklist_step.rb
+- lib/manifestly/entity/endpoint.rb
+- lib/manifestly/entity/user.rb
+- lib/manifestly/entity/workflow.rb
+- lib/manifestly/entity/workflow_step.rb
+- lib/manifestly/http/client.rb
+- lib/manifestly/version.rb
+- manifestly-client.gemspec
+homepage: https://github.com/firespring/manifestly-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Manifest.ly client library for ruby
+test_files: []