frederick_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3de672e56c6302f235bed63e48c4dd11978344ea
-  data.tar.gz: 173a72637912e59ae28c5f99eca47d5c6207dfff
+  metadata.gz: 639b7019e1919ed4998f737434166f9b401484fd
+  data.tar.gz: c793239bf2e75019ca1efe3b53fe2234bbc98fa3
 SHA512:
-  metadata.gz: 076b3051e48620744b08af1d2aae2571edecb87688341d4b748c92503157d6c46e52c4522c5ac0016a64044fcf9a30440ca31cd8b186e805a6608b1b5e0f5446
-  data.tar.gz: 02b1230c8352a91edda3268866b185e54e4397b2185a0d37eaf896bc64f6b72c8b6d61a976865984db9ef70c66f8a0e77ee244d83e979913b83634f2e2d69698
+  metadata.gz: 5e5bcddde1d02e42f58059e5f194fcd446eb0dad19fe8d111c6098025e8f77e95710c4654d40c279a46c62ca51ffde363cda35cfcc030b35bffaff1a6378404a
+  data.tar.gz: bd211000835b4b27f72d07841ef83899ae8c79d119ff8dbd402e18dcd3ec40ea8b83c46d3a446e3ccecc5a7a790cf9f0c8b0850a88f98ebe532a8695ab3762ca

data/README.md

@@ -67,7 +67,7 @@ location_id = '6fdf0530-3e4e-46f1-9d11-5f90c48a50dc'
 access_token = '9jsdo320fjfkfdksls30dfdcd919bcaa1b7804dbbebda0'
 FrederickAPI::V2::Location.with_access_token(access_token) do
   # Fetch a location
-  location = FrederickAPI::V2::Location.find(location_id)
+  location = FrederickAPI::V2::Location.find(location_id).first
   # => #<FrederickAPI::V2::Location:0x007fd2f29a7618>
   
   location.name
@@ -84,3 +84,17 @@ FrederickAPI::V2::Location.with_access_token(access_token) do
   # => true
 end
 ```
+
+### Nested Resources
+
+Nested resources must be accessed using `where` to scope the request:
+
+```ruby
+location_id = '6fdf0530-3e4e-46f1-9d11-5f90c48a50dc'
+access_token = '9jsdo320fjfkfdksls30dfdcd919bcaa1b7804dbbebda0'
+FrederickAPI::V2::Location.with_access_token(access_token) do
+  # Find contacts
+  contacts = FrederickAPI::V2::Contact.where(location_id: location_id).page(1).per(100).to_a
+  # => [...]
+end
+```

data/lib/frederick_api.rb

@@ -11,6 +11,13 @@ require 'frederick_api/v2/resource'
 require 'frederick_api/v2/user'
 require 'frederick_api/v2/location'
 
+# Froldoex resources
+require 'frederick_api/v2/contact'
+require 'frederick_api/v2/contact_property'
+require 'frederick_api/v2/contact_list'
+require 'frederick_api/v2/contact_type'
+require 'frederick_api/v2/interaction'
+
 # Namespace for all Frederick API client methods/classes
 module FrederickAPI
 end

data/lib/frederick_api/v2/contact.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # /v2/locations/:location_id/contacts
+    class Contact < Resource
+      belongs_to :location
+    end
+  end
+end

data/lib/frederick_api/v2/contact_list.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # /v2/locations/:location_id/contact_lists
+    class ContactList < Resource
+      belongs_to :location
+    end
+  end
+end

data/lib/frederick_api/v2/contact_property.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # /v2/locations/:location_id/contact_properties
+    class ContactProperty < Resource
+      belongs_to :location
+    end
+  end
+end

data/lib/frederick_api/v2/contact_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # /v2/locations/:location_id/contact_types
+    class ContactType < Resource
+      belongs_to :location
+    end
+  end
+end

data/lib/frederick_api/v2/interaction.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # /v2/locations/:location_id/interactions
+    class Interaction < Resource
+      belongs_to :location
+    end
+  end
+end

data/lib/frederick_api/v2/location.rb

@@ -2,6 +2,7 @@
 
 module FrederickAPI
   module V2
+    # /v2/locations
     class Location < Resource
     end
   end

data/lib/frederick_api/v2/user.rb

@@ -2,6 +2,7 @@
 
 module FrederickAPI
   module V2
+    # /v2/users
     class User < Resource
     end
   end

data/lib/frederick_api/version.rb

@@ -2,5 +2,5 @@
 
 module FrederickAPI
   # Current gem version
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: frederick_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Frederick Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.1
 description: Ruby client for the Frederick API
@@ -35,6 +35,11 @@ files:
 - README.md
 - lib/frederick_api.rb
 - lib/frederick_api/configuration.rb
+- lib/frederick_api/v2/contact.rb
+- lib/frederick_api/v2/contact_list.rb
+- lib/frederick_api/v2/contact_property.rb
+- lib/frederick_api/v2/contact_type.rb
+- lib/frederick_api/v2/interaction.rb
 - lib/frederick_api/v2/location.rb
 - lib/frederick_api/v2/query_builder.rb
 - lib/frederick_api/v2/resource.rb