fixably 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdd2d8cd3fb2feb9a44e920cfe03b421911e09d70808d6ba69268699ce557349
-  data.tar.gz: 974d79e711fd2bdaf019ccbca392a75cfbe9b754cc698b7b5de792acf03bb819
+  metadata.gz: a9d5277a0ba5d3af5ae44a46535773a0d37abced3961e2dec3b43b04fe7d31e3
+  data.tar.gz: e3fd8a7cfa9ce0ac0702301bacce2423e8654970afab2cdf4aeeb6f3629a009a
 SHA512:
-  metadata.gz: b13cdf4844e36560af8581b62e7588823818801a7ebeeac470a6feea0da824646c3ef968ee71da60a1bc636fa908591c910e1818eb5a945d787432087b8c3fa2
-  data.tar.gz: 19bff33581a964cddf870f33f1ba96a6b2986958240fb5f6e8fc1f693be032e3e9f12d2cf2b4c7fa008d59a9d881bc5ca71f97d13d308cd72a926f07dbb367f8
+  metadata.gz: '0941d4b684ab7e4dc37a1f930207e8cd9a922779ed0371f51e07a518c594e9fc33320d917bf24bd99b968e4e9e33c83388fc06c85c4b7ebb26c7cad516296467'
+  data.tar.gz: 2f74f0fd34354408ada06e2a5442f75fa1dd4c83b805c021a90292414a49c617166cfd99640b9c8f3f1a07a1e57089547f2e107d0a918e227b1efee99cf0b332

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fixably (0.1.0)
+    fixably (0.5.0)
       activeresource (~> 5)
 
 GEM

data/README.md

@@ -116,6 +116,7 @@ Currently supported resources:
 - Fixably::Customer ([documentation](docs/customer.md))
 - Fixably::Customer::Child ([documentation](docs/customer/child.md))
 - Fixably::Device ([documentation](docs/device.md))
+- Fixably::Location ([documentation](docs/location.md))
 - Fixably::Order ([documentation](docs/order.md))
 - Fixably::Order::Line ([documentation](docs/order/line.md))
 - Fixably::Order::Note ([documentation](docs/order/note.md))

data/docs/customer/child.md

@@ -7,7 +7,7 @@ The Fixably API does not allow children to be searched
 ## Get a child
 
 ```ruby
-Fixably::Customer::Child.find(1000, customer_id: 1000)
+Fixably::Customer::Child.find(1_000, customer_id: 1_000)
 ```
 
 ## Create a child

data/docs/location.md

@@ -0,0 +1,33 @@
+# Fixably::Location
+
+## List location
+
+```ruby
+Fixably::Location.all
+Fixably::Location.where(name: "Our location")
+```
+
+### Include associations in a list
+
+**Deliveries**
+Currently not implemented
+
+## Get a location
+
+```ruby
+Fixably::Location.find(1_000)
+Fixably::Location.first
+Fixably::Location.last
+```
+
+## Create a location
+
+The Fixably API does not allow locations to be created
+
+## Update a location
+
+The Fixably API does not allow locations to be updated
+
+## Destroy a location
+
+The Fixably API does not allow locations to be destroyed

data/docs/order/line.md

@@ -3,15 +3,15 @@
 ## List order lines
 
 ```ruby
-Fixably::Order::Line.all(order_id: 1000)
+Fixably::Order::Line.all(order_id: 1_000)
 ```
 
 ## Get an order line
 
 ```ruby
-Fixably::Order::Line.find(1000, order_id: 1000)
-Fixably::Order::Line.first(order_id: 1000)
-Fixably::Order::Line.last(order_id: 1000)
+Fixably::Order::Line.find(1_000, order_id: 1_000)
+Fixably::Order::Line.first(order_id: 1_000)
+Fixably::Order::Line.last(order_id: 1_000)
 ```
 
 ## Create an order line

data/docs/order/note.md

@@ -3,15 +3,22 @@
 ## List order notes
 
 ```ruby
-Fixably::Order::Note.all(order_id: 1000)
+Fixably::Order::Note.all(order_id: 1_000)
+```
+
+### Include associations in a list
+
+**Created by**
+```ruby
+Fixably::Order.includes(:created_by).all(order_id: 1_000)
 ```
 
 ## Get an order note
 
 ```ruby
-Fixably::Order::Note.find(1000, order_id: 1000)
-Fixably::Order::Note.first(order_id: 1000)
-Fixably::Order::Note.last(order_id: 1000)
+Fixably::Order::Note.find(1_000, order_id: 1_000)
+Fixably::Order::Note.first(order_id: 1_000)
+Fixably::Order::Note.last(order_id: 1_000)
 ```
 
 ## Create an order note

data/docs/order/task.md

@@ -3,15 +3,15 @@
 ## List order tasks
 
 ```ruby
-Fixably::Order::Task.all(order_id: 1000)
+Fixably::Order::Task.all(order_id: 1_000)
 ```
 
 ## Get an order task
 
 ```ruby
-Fixably::Order::Task.find(1000, order_id: 1000)
-Fixably::Order::Task.first(order_id: 1000)
-Fixably::Order::Task.last(order_id: 1000)
+Fixably::Order::Task.find(1_000, order_id: 1_000)
+Fixably::Order::Task.first(order_id: 1_000)
+Fixably::Order::Task.last(order_id: 1_000)
 ```
 
 ## Create an order task

data/docs/order.md

@@ -37,6 +37,12 @@ Fixably::Order.includes(:handled_by).all
 Fixably::Order.includes(:handled_by).where(internal_location: "SERVICE")
 ```
 
+**Location**
+```ruby
+Fixably::Order.includes(:location).all
+Fixably::Order.includes(:location).where(internal_location: "SERVICE")
+```
+
 **Ordered by**
 ```ruby
 Fixably::Order.includes(:ordered_by).all
@@ -73,7 +79,7 @@ Fixably::Order.includes(:tasks).all
 Fixably::Order.includes(:tasks).where(internal_location: "SERVICE")
 ```
 
-## Get a customer
+## Get an order
 
 ```ruby
 Fixably::Order.find(1_000)

data/lib/fixably/argument_parameterisation.rb

@@ -33,12 +33,13 @@ module Fixably
     end
 
     def expand_association(association)
+      association_name = association.to_s.camelize(:lower)
       relationship = reflections.fetch(association).macro
       case relationship
       when :has_one
-        association
+        association_name
       when :has_many
-        "#{association}(items)"
+        "#{association_name}(items)"
       else
         raise ArgumentError, "Unknown relationship, #{relationship}"
       end

data/lib/fixably/encoding.rb

@@ -17,14 +17,14 @@ module Fixably
 
     def remove_on_encode = %w[created_at href id]
 
-    private
-
     def remove_has_many_associations(attrs)
       reflections.select { _2.macro.equal?(:has_many) }.keys.each do
         attrs.delete(_1)
       end
     end
 
+    private
+
     def remove_unallowed_parameters(attrs)
       remove_on_encode.each { attrs.delete(_1) }
     end

data/lib/fixably/resources/location.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Fixably
+  class Location < ApplicationResource
+    actions %i[list show]
+
+    # TODO
+    # has_many :deliveries
+  end
+end

data/lib/fixably/resources/order.rb

@@ -14,6 +14,7 @@ module Fixably
     has_one :customer, class_name: "fixably/customer"
     has_one :device, class_name: "fixably/device"
     has_one :handled_by, class_name: "fixably/customer"
+    has_one :location, class_name: "fixably/location"
     has_one :ordered_by, class_name: "fixably/customer"
     has_one :queue, class_name: "fixably/queue"
     has_one :status, class_name: "fixably/status"
@@ -23,7 +24,6 @@ module Fixably
     has_many :tasks, class_name: "fixably/order/task"
 
     # TODO
-    # has_one :location
     # has_one :store
 
     ALLOWED_INTERNAL_LOCATIONS =
@@ -39,6 +39,15 @@ module Fixably
       allow_nil: true
     )
 
+    protected
+
+    def remove_has_many_associations(attrs)
+      reflections.select { |_, reflection| reflection.macro.equal?(:has_many) }.
+        keys.
+        reject { _1.equal?(:notes) }.
+        each { attrs.delete(_1) }
+    end
+
     class Contact < ApplicationResource
       schema do
         string :full_name
@@ -71,17 +80,12 @@ module Fixably
         string :text
         string :type
       end
+
+      has_one :created_by, class_name: "fixably/user"
     end
 
     class Task < ApplicationResource
-      actions %i[list show update]
-
-      # TODO
-      # has_one :task
-
-      def update
-        raise "Updating order tasks has not been implemented"
-      end
+      actions %i[list show]
     end
   end
 end

data/lib/fixably/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fixably
-  VERSION = "0.1.0"
+  VERSION = "0.5.0"
 end

data/lib/fixably.rb

@@ -11,6 +11,7 @@ require "fixably/version"
 require_relative "fixably/application_resource"
 require_relative "fixably/resources/customer"
 require_relative "fixably/resources/device"
+require_relative "fixably/resources/location"
 require_relative "fixably/resources/order"
 require_relative "fixably/resources/queue"
 require_relative "fixably/resources/status"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixably
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Adam Rice
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-12 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -160,6 +160,7 @@ files:
 - docs/customer.md
 - docs/customer/child.md
 - docs/device.md
+- docs/location.md
 - docs/order.md
 - docs/order/line.md
 - docs/order/note.md
@@ -184,6 +185,7 @@ files:
 - lib/fixably/resource_lazy_loader.rb
 - lib/fixably/resources/customer.rb
 - lib/fixably/resources/device.rb
+- lib/fixably/resources/location.rb
 - lib/fixably/resources/order.rb
 - lib/fixably/resources/queue.rb
 - lib/fixably/resources/status.rb