rtx-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ddf0a887ad4ab9c10f14dda325f71149306f655
-  data.tar.gz: c156a95bc0c17f2beb8508c973350355b4d54d97
+  metadata.gz: a7517784db2586173fe6d8f89d9a715834b413e3
+  data.tar.gz: a69406c3015e7354ffb81391297065785087f9b6
 SHA512:
-  metadata.gz: d8f74bf14caf3dbd7f9d35702877b4f2aeff4b24a05b28fc17d5894a41975dac552f0310dd418a5c2cd8e08d4181346ce14ce94093fa3b35677a7375a8ff775b
-  data.tar.gz: 8373ea691bcd64d4f4f164a9bb17fb36cf1a1c618e87c373234c196c9e8bbdfc12fba8ec8a89908d96abcefb064c7a9ee67b4b887e7f8e59be4bdfb889f0594f
+  metadata.gz: 02a241999b9dc5c24f904b1c80dbbeda32165cedae82c7ca8956c6b6e335dcf25767bb0c2fe93220506ca6ebb8859cde71ecc274900dc30c66d1f46f64a41e48
+  data.tar.gz: 289ba8e9120b8d91878747f699c0005170b5958408f38b2f0b4247583a461275c9ded6b8e1cb654c5b309d618af9be07ac50b9a518427d14f56bea4c5eb5128e

data/README.md

@@ -207,6 +207,15 @@ The `create!` method will perform the create and return the new object
 note = client.notes.create!(review_id: "56f2ad01565d61bb2a606329", location_id: "566c91337536e826ec8ebfa0", content: "This is my note!")
 ```
 
+### Resource Detail
+
+The `detail!` method will perform a GET request that returns an object instead of an array
+
+```ruby
+# Get a note
+note = client.notes.detail!(id: "56f2ad01565d61bb2a606329", account_id: "566c91337536e826ec8ebfa0")
+```
+
 ### Updating a Resource
 
 The `update!` method will perform the update via PUT and return the new object

data/lib/rtx/api/client.rb

@@ -50,12 +50,19 @@ module RTX
         end
       end
 
-      def get(resource_name, attrs = {})
+      def collection(resource_name, attrs = {})
         resource_exists?(resource_name)
         request = self.class.get("#{rtx_api_url}/#{resource_name}", options(:get, attrs))
         handle_request(request)
       end
 
+      def detail(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.get("#{rtx_api_url}/#{resource_name}/#{resource_id}", options(:get, attrs))
+        handle_request(request)
+      end
+
       def post(resource_name, attrs = {})
         resource_exists?(resource_name)
         request = self.class.post("#{rtx_api_url}/#{resource_name}", options(:post, attrs))

data/lib/rtx/api/collection.rb

@@ -16,6 +16,12 @@ module RTX
         post(symbolize_hash(attrs))
       end
 
+      # Gets an individual resource returns an object instead of an array
+      def detail!(attrs = {})
+        client.authenticate if !client.authenticated?
+        detail(symbolize_hash(attrs))
+      end
+
       # Updates a resource via PUT and returns it on success
       def update!(attrs = {})
         client.authenticate if !client.authenticated?
@@ -51,14 +57,14 @@ module RTX
       # Returns all data associated with the existing response
       def data
         client.authenticate if !client.authenticated?
-        get if !has_response?
+        collection if !has_response?
         response[:_embedded][resource_name]
       end
 
       # Returns the metadata about the current response
       def meta
         client.authenticate if !client.authenticated?
-        get if !has_response?
+        collection if !has_response?
         response.reject {|key,_| key == :_embedded}
       end
 
@@ -130,8 +136,13 @@ module RTX
         options[:page]
       end
 
-      def get
-        @response = client.get(resource_name, options)
+      def collection
+        @response = client.collection(resource_name, options)
+      end
+
+      def detail(attrs = {})
+        resource_id = attrs[:id]
+        client.detail(resource_name, resource_id)
       end
 
       def post(attrs = {})

data/lib/rtx/api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtx-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ReviewTrackers Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty