arcgis-opendata 0.0.6 → 0.0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45bd9d987a78c6dd42d3990c6dd2f23976afb633
-  data.tar.gz: 8a70222a96289c8832b1f6e97720e014066ffeb6
+  metadata.gz: e7ce8ba7a55091fc17bce28e6d22fab327e7c390
+  data.tar.gz: 54ac2e9fdf640bb8625dc9de816b8f7c413d9041
 SHA512:
-  metadata.gz: 9c9666b49c7acd7dc8421fd0d10b9aebd280ea9e3c5e6a0fc3a4bd0dce5cd48e43829ef8d168edb07b3fb49e471004762dc14c137c6b62d97d82c8567d1559f1
-  data.tar.gz: 64b8053ab24c769b06fae0376b0bd851c40f39bac1ca39710cd30ee70ded33058b9f9a8bce6ebef32c0652f913d1bd2b13d7ba3c7f8a9851364a4de56a36549a
+  metadata.gz: a6483cceec52a6c9a4e5516de800acfbe29d515b1c26d59b104ae52562e83b51f0652f144f884d4583e16bd6754a944ff20ca66aecbfff81077b7a80fe7b6ebb
+  data.tar.gz: 69d6b66e9b6332e8e23b59638b1cb860bbfeed02648e3a2be68425c813effbf251fee54e4996283194a59c41364a0f458ff4983e9343e0897e606e99e43e6d62

data/README.md

@@ -77,6 +77,22 @@ response = client.dataset_show('4df13_11', include: 'organizations,groups')
 # => returns a Faraday::Response object
 ```
 
+### Learn how the parameters turn into request urls
+
+If you're curious about how urls are turned into API calls there are public methods that return the urls that would be created
+based on the parameters you pass in. I'm a fan of not completely abstracting the underlying API, and I also like urls a lot so
+we have these methods to allow developers to learn how urls are constructed.
+
+```ruby
+client = Opendata.new('https://opendata.arcgis.com')
+
+client.dataset_list_url(q: 'census', page: { size: 25 }, include: 'organizations,sites', sort: '-updated_at')
+#=> '/api/v2/datasets?q=census&page%5Bsize%5D=25&include=organizations%2Csites&sort=-updated_at'
+
+client.dataset_show_url('5353e1550e964d39b9bdde5ff391ab09_0', include: 'organizations')
+#=> '/api/v2/datasets/5353e1550e964d39b9bdde5ff391ab09_0?include=organizations'
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. ~~You can also run `bin/console` for an interactive prompt that will allow you to experiment.~~ `bin/console` is currently not working

data/lib/client.rb

@@ -19,13 +19,13 @@ module Opendata
     # @param params [Hash] query parameters for Dataset resources
     # @return [Object] Faraday::Response object
     def dataset_list(params = {})
-      connection.get(dataset_list_request(params))
+      connection.get(dataset_list_url(params))
     end
 
     # Makes requests for 'logical collections' of Dataset resources (zero-to-many potential dataset resources)
     # @param params [Hash] query parameters for Dataset resources
     # @return [String] request url based on the parameters specfied
-    def dataset_list_request(params = {})
+    def dataset_list_url(params = {})
       DATASETS_API_PATH + param_to_query_string(params)
     end
 
@@ -46,6 +46,8 @@ module Opendata
       DATASETS_API_PATH + "/#{id}" + param_to_query_string(params)
     end
 
+    private
+
     def param_to_query_string(params)
       adjusted_params = {}
 
@@ -65,8 +67,6 @@ module Opendata
 
       query_string == "" ? query_string : "?#{query_string}"
     end
-
-    private
     
     attr_reader :connection
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Opendata
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.6.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arcgis-opendata
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.6.1
 platform: ruby
 authors:
 - Alexander Harris