rtx-api 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d07f27e94f812c2b5ccbe8b88db45ac143f235f
-  data.tar.gz: 1870fed081935a8eb94375cb14d5ad6019aa726b
+  metadata.gz: 7ddf0a887ad4ab9c10f14dda325f71149306f655
+  data.tar.gz: c156a95bc0c17f2beb8508c973350355b4d54d97
 SHA512:
-  metadata.gz: 62bf561923b34c05841d5146132e644e721b357e63076bb73e95478b1ac9a447ac67c45686aa8968479f689245f31350cc150858d945bc2e97509ea6f8951a1b
-  data.tar.gz: 8e8dee210c598a5c2074358c9f55d2ae0ecc3609d8276d72695f0e2a074ca89b6e2ad4fbed2e5618a134a6f60cb8f5376947091e8474626766c614d13487f177
+  metadata.gz: d8f74bf14caf3dbd7f9d35702877b4f2aeff4b24a05b28fc17d5894a41975dac552f0310dd418a5c2cd8e08d4181346ce14ce94093fa3b35677a7375a8ff775b
+  data.tar.gz: 8373ea691bcd64d4f4f164a9bb17fb36cf1a1c618e87c373234c196c9e8bbdfc12fba8ec8a89908d96abcefb064c7a9ee67b4b887e7f8e59be4bdfb889f0594f

data/README.md

@@ -209,13 +209,20 @@ note = client.notes.create!(review_id: "56f2ad01565d61bb2a606329", location_id:
 
 ### Updating a Resource
 
-The `update!` method will perform the update and return the new object
+The `update!` method will perform the update via PUT and return the new object
 
 ```ruby
-# Update a review
+# Update a review via PUT
 review = client.reviews.update!(id: "56f2ad01565d61bb2a606329", summary: "Updated Summary Text")
 ```
 
+The `patch!` method will perform the update via PATCH and return the new object
+
+```ruby
+# Update a review via PATCH
+review = client.reviews.patch!(id: "56f2ad01565d61bb2a606329", summary: "Updated Summary Text")
+```
+
 ### Deleting a Resource
 
 The `delete!` method will perform the update and return true on success

data/lib/rtx/api/client.rb

@@ -69,6 +69,13 @@ module RTX
         handle_request(request)
       end
 
+      def patch(resource_name, resource_id, attrs = {})
+        resource_exists?(resource_name)
+        raise API::Errors::RequestError.new("id was not provided") if resource_id.nil?
+        request = self.class.patch("#{rtx_api_url}/#{resource_name}/#{resource_id}", options(:patch, attrs))
+        handle_request(request)
+      end
+
       def delete(resource_name, resource_id)
         resource_exists?(resource_name)
         raise API::Errors::RequestError.new("id was not provided") if resource_id.nil?
@@ -113,7 +120,7 @@ module RTX
         params = default_params.merge(attrs)
         options = {headers: default_headers, basic_auth: {username: email, password: token}}
         if write_request?(action)
-          options[:body] = Oj.dump(params, mode: :compat)
+          options[:body] = Oj.dump(attrs, mode: :compat)
         else
           options[:query] = params
         end
@@ -125,7 +132,7 @@ module RTX
       end
 
       def write_request?(action)
-        (action == :post || action == :put)
+        (action == :post || action == :put || action == :patch)
       end
     end
   end

data/lib/rtx/api/collection.rb

@@ -22,6 +22,12 @@ module RTX
         put(symbolize_hash(attrs))
       end
 
+      # Updates a resource via PATCH and returns it on success
+      def patch!(attrs = {})
+        client.authenticate if !client.authenticated?
+        patch(symbolize_hash(attrs))
+      end
+
       # Deletes a resource via DELETE and returns true on success
       def delete!(attrs = {})
         client.authenticate if !client.authenticated?
@@ -137,6 +143,11 @@ module RTX
         client.put(resource_name, resource_id, attrs)
       end
 
+      def patch(attrs = {})
+        resource_id = attrs[:id]
+        client.patch(resource_name, resource_id, attrs)
+      end
+
       def delete(attrs = {})
         resource_id = attrs[:id]
         client.delete(resource_name, resource_id)

data/lib/rtx/api/version.rb

@@ -1,5 +1,5 @@
 module RTX
   module API
-    VERSION = "0.0.8"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtx-api
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - ReviewTrackers Engineering