manifestly-client 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 636afd68b4507041c22815fd31b8952d94c5b849b2a1cb5dfad870005d1254c1
-  data.tar.gz: b1ded85331108c971a6643494b6b39b4b5ec110169858ab05ff09a05febae554
+  metadata.gz: 9cd08e5fcf5d6cc1c5784fb8ccc8b9276d83fee49223236754a40834a312cddb
+  data.tar.gz: 0cad3e6e1d87522fcc87ed716fae04b4f5f2c8f99ffce4f95713b0400584372b
 SHA512:
-  metadata.gz: aafcd3b3735ff5fe8eb97c300a69ef8664c861ea00f929886c4ef6e2f2888f9a176fc86490009d988418a50747eb653ebb2de4b024d5ba46c674273965d5040a
-  data.tar.gz: '025857d602d440a7e858482a59c334873ffe303de082b81b01755e7fadcecdd62e7f1826324ae1da98d68b29d8fbd98ab0f453779ea6f6f586284761b93c9e64'
+  metadata.gz: 21974177cd03dad15708b1dff4e6a6a3d5039866827d8061574ab621586e95300663428ccdfad012d83846e19564411eaaf62685013b83dc407885646092c605
+  data.tar.gz: 2351717f5e532bc4ce0d504be33ad3e8273100b87ff45ae6a7ead9ee2e8462c4b5db09b5f56426703aaea938dbf9231b1e0a69d90da9578e472a33c67a1fd611

data/.travis.yml

@@ -2,9 +2,18 @@ language: ruby
 cache: bundler
 rvm: 2.4
 script:
+  - bundle exec bundle-audit update && bundle exec bundle-audit check
   - bundle exec rspec spec/unit
   - bundle exec rubocop
 deploy:
+  - provider: releases
+    api_key:
+      secure: ljBnXvc8L+BxeJshZ5+67vsEp5ixShklubZ2/fqqMN1jscgzkjXYmr5+Vr06ndiK4pnorZRIXYK0CZHye8+Yf8OJCLHss+6/pToE2Dw+WkBCWPrq7TJzd5G3hufTyMJ4nNdXmrJqYYmZi6SYvLLdK/7m738wdumHmT+OGH4XPi1Rl6KaPnrnqI4Jlrbdmg6w0Nq7EELh5tjlJjjJ2U4XN7+NzsDJJixjizsiKA66vzfhjSJ56gZe6L+GRtkbT3BIq9bK+YYpTDbuXiQWM4opdK/OLnoWTLRlnerrVwrV1vlWRdXMJe5S24jiiFX5a7mop8gLfSQICXRrfgt3U/+2H405khf5ahwIwqZm7N4ebQOW4MCKedjlvBD4+SInghCYs6HKczhnhiDqQwQsL/YKf3l81LjuAbabv/iFNrjFcVip06E567YIWkSb/PM6QkHKXBzf9koahF6Vg3P9msw1fvc5EcYeyiuiqv7+wTZVKz+7NJkO7az92Vahb99qIW4/RlSmYmS9uTo6CfJ1k8ZdoJSLEq6kXKxFryCQ7g+3Lwh8GVdgZuGgPelLVMV8TitP6D0KNu8cXD6Mugpf+f5p2ZoZGbGOQYdrNOA72MrHAI+SCcM6E/QUAz4e9t5S3EA8+x2Ns3rAmi6Wxuae45o8ovghlyQsfGFlr48pfuHCSic=
+    file_glob: true
+    file: manifestly-client-*.gem
+    on:
+      tags: true
+      repo: firespring/manifestly-ruby
   - provider: rubygems
     api_key:
       secure: FRUmy4P70d/oNd4Kom5af5NJ+6bqf4fJUrVZJGU1j+j5GjNNUTVsXdN+FU3nRgiukGxplYl48/RMDnfmEAkgLtF21lKp2f081LOuJ1PaaO3UquNIUULYrrxSu+zWHfdx6B9IZKVVxMmX1y+gb1z8TxhNpkZsfeu+uo3kjyESX4NHYxLSmPsjMhTnxnzspZ996PudDSrw4IGwWDkQ6Tkcn0mL0EhTUjmL6/HGJ+0U0vCh3GMbTw8jYcp76nUjn6mc1nmJ2HebnkZVKchoWOWwH7wOBmY8tDZZqohE0XJsOTGBf3ogZlZJCI/NmvlfP0DWuSPER92/4ew7wKeOIxHGwPXNtG4s7ttMGiR2d0XeIrT2OLj++5nNo2dGX9WcWtOq3605Eu9lyY7aT8aQLqO+jR1lV2FfNnh2Uw/SnKjYUAF4k36/D0MFS1dW8y/FqsA0U++M1Vo6dWxqnmQdhyFRiH+6kJOVIq1peZiXWhPqY+soLk5iS7M8AEg1yBRkfBFYjHETSkQJqVWZ6khabRtPdQe22kmc9VqbhksU6dT6Hq4gwEoVpzGWv4IBrHawMwO4sY41Is6fL1R9ypFCdqtH4ZAtb33TC1HFzD6vrPciVXRrcuuZY4pKHtOK/fnw1Va2zYmREmTGi71jNN9oj7ItyxCXCl3pu53cScS6w7cYxbY=

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'bundler-audit'
   gem 'factory_bot'
   gem 'faker'
   gem 'rspec'

data/README.md

@@ -1,4 +1,6 @@
 # Manifest.ly Ruby Client
+[![Gem Version](https://badge.fury.io/rb/manifestly-client.svg)](https://badge.fury.io/rb/manifestly-client)
+[![Build Status](https://api.travis-ci.org/firespring/manifestly-ruby.svg?branch=master)](https://travis-ci.org/firespring/manifestly-ruby)
 
 A Ruby client that enables quick and easy interactions with the Manifest.ly api.
 
@@ -34,14 +36,14 @@ puts Manifestly::Entity::Workflow.list.inspect
 
 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'}
+data = {title: 'Test Workflow', external_id: 'abc123'}
 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'}
+data = {title: 'Test Workflow Upsert', external_id: 'def456'}
 workflow = Manifestly::Entity::Workflow.new(data).create
 
 workflow.title = "#{workflow.title} (updated)"
@@ -50,7 +52,7 @@ 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'}
+data = {title: 'Test Workflow Delete', external_id: 'ghi789'}
 workflow = Manifestly::Entity::Workflow.new(data).create
 workflow.delete
 ```
@@ -59,7 +61,7 @@ workflow.delete
 
 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'}]}
+data = {title: 'Test Workflow with steps', external_id: 'jkl012', steps: [{title: 'Step One'}]}
 workflow = Manifestly::Entity::Workflow.new(data)
 workflow.create
 ```
@@ -71,11 +73,10 @@ You may start a new checklist run by passing a hash of data to the ChecklistRun
 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 Workflow for checklist run', external_id: 'mno345', steps: [{title: 'Step One'}]}
+workflow = Manifestly::Entity::Workflow.new(data).create
 
-data = {title: "Test Run", checklist_id: workflow.id, users: [my_user.id]}
+data = {title: 'Test Run', checklist_id: workflow.id, users: [my_user.id]}
 checklist_run = Manifestly::Entity::ChecklistRun.new(data).create
 ```
 
@@ -84,11 +85,14 @@ You may complete a checklist step by calling the corresponding method on the ste
 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
+data = {title: 'Test Workflow for checklist run step complete', external_id: 'pqr678', steps: [{title: 'Step One'}]}
+workflow = Manifestly::Entity::Workflow.new(data).create
+
+data = {title: 'Test Run step complete', checklist_id: workflow.id, users: [my_user.id]}
+checklist_run = Manifestly::Entity::ChecklistRun.new(data).create
 
-step.assign(my_user.id)
-step.complete
+checklist_run.steps.first.assign(my_user.id)
+checklist_run.steps.first.complete
 ```
 
 ## Supported Ruby Versions

data/lib/manifestly/entity/checklist_run.rb

@@ -25,8 +25,8 @@ module Manifestly
       attr_reader :users
       attr_accessor :origin
 
-      def self.path
-        'runs'
+      def self.endpoint_target
+        :runs
       end
 
       def users=(values)
@@ -39,7 +39,10 @@ module Manifestly
       end
 
       def steps
-        @steps ||= Manifestly::Entity::ChecklistStep.list(self)
+        return @steps if @steps
+
+        @steps = Manifestly::Entity::ChecklistRunStep.list(self) if id
+        @steps ||= []
       end
     end
   end

data/lib/manifestly/entity/{checklist_step.rb → checklist_run_step.rb}

@@ -3,7 +3,7 @@ require 'date'
 
 module Manifestly
   module Entity
-    class ChecklistStep < Endpoint
+    class ChecklistRunStep < ChildEndpoint
       attr_accessor :id
       attr_accessor :assignee_avatar_url
       attr_accessor :assignee_id
@@ -32,11 +32,12 @@ module Manifestly
       invalid_method(:save)
       invalid_method(:delete)
 
-      def initialize(run, data = {})
-        raise 'invalid checklist run' unless run.is_a?(ChecklistRun)
+      def self.parent_class
+        ChecklistRun
+      end
 
-        @parent = run
-        super(data)
+      def self.endpoint_target
+        :run_steps
       end
 
       # Header step needs to always be a boolean (even if not set)
@@ -49,60 +50,50 @@ module Manifestly
         @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")
+        client.post("#{location}/#{id}/complete")
         @parent.instance_variable_set(:@steps, nil)
         nil
       end
 
       def uncomplete
-        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/uncomplete")
+        client.post("#{location}/#{id}/uncomplete")
         @parent.instance_variable_set(:@steps, nil)
         nil
       end
 
       def skip
-        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/skip")
+        client.post("#{location}/#{id}/skip")
         @parent.instance_variable_set(:@steps, nil)
         nil
       end
 
       def unskip
-        client.post("#{@parent.path}/#{@parent.id}/#{path}/#{id}/unskip")
+        client.post("#{location}/#{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})
+        client.post("#{location}/#{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})
+        client.post("#{location}/#{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})
+        client.post("#{location}/#{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})
+        client.post("#{location}/#{id}/assign", params: {assignee_user_id: user_id})
         @parent.instance_variable_set(:@steps, nil)
         nil
       end

data/lib/manifestly/entity/endpoint.rb

@@ -6,12 +6,28 @@ module Manifestly
     class Endpoint < Base
       @client = nil
 
-      def path
-        self.class.path
+      def self.endpoint_target
+        raise 'Must specify endpoint_target'
       end
 
-      def self.path
-        raise 'Must override method'
+      def endpoint_target
+        self.class.endpoint_target
+      end
+
+      def self.singular_endpoint_target
+        endpoint_target.to_s.chomp('s').to_sym
+      end
+
+      def singular_endpoint_target
+        self.class.singular_endpoint_target
+      end
+
+      def location
+        self.class.location
+      end
+
+      def self.location
+        endpoint_target
       end
 
       def client
@@ -22,26 +38,26 @@ module Manifestly
         @client ||= Manifestly::Client.new
       end
 
-      def create
+      def create(path: location)
         response = client.post(path, params: to_h)
-        json_entity = JSON.parse(response[:body], symbolize_names: true)[path.chomp('s').to_sym]
+        json_entity = JSON.parse(response[:body], symbolize_names: true)[singular_endpoint_target]
         self.attributes = json_entity
         self
       end
 
-      def self.list(**params)
+      def self.list(path: location, **params)
         response = client.get(path, params: params)
-        json_entities = JSON.parse(response[:body], symbolize_names: true)[path.to_sym]
+        json_entities = JSON.parse(response[:body], symbolize_names: true)[endpoint_target]
         json_entities.map { |it| new(it) }
       end
 
-      def self.get(id)
+      def self.get(id, path: location)
         response = client.get("#{path}/#{id}")
-        json_entity = JSON.parse(response[:body], symbolize_names: true)[path.chomp('s').to_sym]
+        json_entity = JSON.parse(response[:body], symbolize_names: true)[singular_endpoint_target.to_sym]
         new(json_entity)
       end
 
-      def update
+      def update(path: location)
         client.post("#{path}/#{id}", params: to_h)
         self
       end
@@ -54,10 +70,57 @@ module Manifestly
         end
       end
 
-      def delete
+      def delete(path: location)
         client.delete(path, params: {external_id: external_id})
         nil
       end
     end
+
+    class ChildEndpoint < Endpoint
+      def parent_class
+        self.class.parent_class
+      end
+
+      def self.parent_class
+        raise 'Must specify parent_class'
+      end
+
+      def initialize(parent, data = {})
+        raise "invalid #{parent_class}" unless parent.is_a?(parent_class)
+
+        @parent = parent
+        super(data)
+      end
+
+      def location
+        self.class.location(@parent)
+      end
+
+      def self.location(parent)
+        "#{parent.location}/#{parent.id}/#{endpoint_target}"
+      end
+
+      def self.list(parent, **params)
+        response = client.get(location(parent), params: params)
+        json_entities = JSON.parse(response[:body], symbolize_names: true)[endpoint_target]
+        json_entities.map { |it| new(parent, it) }
+      end
+
+      def self.get(id, parent)
+        response = client.get("#{location(parent)}/#{id}")
+        json_entity = JSON.parse(response[:body], symbolize_names: true)[singular_endpoint_target.to_sym]
+        new(parent, json_entity)
+      end
+
+      def update(path: location)
+        client.put("#{path}/#{id}", params: to_h)
+        self
+      end
+
+      def delete(path: location)
+        client.delete("#{path}/#{id}")
+        nil
+      end
+    end
   end
 end

data/lib/manifestly/entity/user.rb

@@ -18,8 +18,8 @@ module Manifestly
       invalid_method(:save)
       invalid_method(:delete)
 
-      def self.path
-        'users'
+      def self.endpoint_target
+        :users
       end
     end
   end

data/lib/manifestly/entity/workflow.rb

@@ -15,8 +15,8 @@ module Manifestly
       attr_reader :tag_list
       attr_accessor :title
 
-      def self.path
-        'checklists'
+      def self.endpoint_target
+        :checklists
       end
 
       # Workflows use an 'upsert' methodology so the create and update routes are shared.
@@ -28,8 +28,7 @@ module Manifestly
       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 = Manifestly::Entity::WorkflowStep.list(self) if id
         @steps ||= []
       end
 

data/lib/manifestly/entity/workflow_step.rb

@@ -2,7 +2,7 @@ require_relative 'endpoint'
 
 module Manifestly
   module Entity
-    class WorkflowStep < Base
+    class WorkflowStep < ChildEndpoint
       attr_accessor :id
       attr_accessor :checklist_id
       attr_accessor :position
@@ -19,11 +19,29 @@ module Manifestly
       attr_accessor :late_at_basis
       attr_accessor :parent_step_id
 
-      def initialize(workflow, data = {})
-        raise 'invalid workflow' unless workflow.is_a?(Workflow)
+      invalid_method(:create)
+      invalid_class_method(:get)
+      invalid_method(:update)
+      invalid_method(:save)
+      invalid_method(:delete)
 
-        @parent = workflow
-        super(data)
+      def self.parent_class
+        Workflow
+      end
+
+      def self.endpoint_target
+        :steps
+      end
+
+      def content_objects
+        return @content_objects if @content_objects
+
+        @content_objects = Manifestly::Entity::WorkflowStepContentObject.list(self) if id
+        @content_objects ||= []
+      end
+
+      def content_objects=(values)
+        @content_objects = Array(values).map { |it| WorkflowStepContentObject.new(self, it) }
       end
 
       # Header step needs to always be a boolean (even if not set)

data/lib/manifestly/entity/workflow_step_content_object.rb

@@ -0,0 +1,21 @@
+require_relative 'endpoint'
+
+module Manifestly
+  module Entity
+    class WorkflowStepContentObject < ChildEndpoint
+      attr_accessor :id
+      attr_accessor :caption
+      attr_accessor :content
+      attr_accessor :content_type
+      attr_accessor :position
+
+      def self.parent_class
+        WorkflowStep
+      end
+
+      def self.endpoint_target
+        :content_objects
+      end
+    end
+  end
+end

data/lib/manifestly/http/client.rb

@@ -34,6 +34,17 @@ module Manifestly
       Faraday.post(path, params.to_json, headers)
     end
 
+    def put(path, params: {}, headers: {})
+      handle_request { raw_put("#{url}/#{api_version}/#{path}", params: params, headers: headers) }
+    end
+
+    private def raw_put(path, params: {}, headers: {})
+      include_api_key!(params)
+      include_json_content_type!(headers)
+      include_json_accept!(headers)
+      Faraday.put(path, params.to_json, headers)
+    end
+
     def delete(path, params: {}, headers: {})
       handle_request { raw_delete("#{url}/#{api_version}/#{path}", params: params, headers: headers) }
     end

data/lib/manifestly/version.rb

@@ -1,3 +1,3 @@
 module Manifestly
-  VERSION = '0.0.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manifestly-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Firespring
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -62,11 +62,12 @@ files:
 - lib/manifestly.rb
 - lib/manifestly/entity/base.rb
 - lib/manifestly/entity/checklist_run.rb
-- lib/manifestly/entity/checklist_step.rb
+- lib/manifestly/entity/checklist_run_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/entity/workflow_step_content_object.rb
 - lib/manifestly/http/client.rb
 - lib/manifestly/version.rb
 - manifestly-client.gemspec