arcgis-opendata 0.0.6.1 → 0.0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7ce8ba7a55091fc17bce28e6d22fab327e7c390
-  data.tar.gz: 54ac2e9fdf640bb8625dc9de816b8f7c413d9041
+  metadata.gz: eefd21b860fbf351964f16b82afaeb82218a9bd4
+  data.tar.gz: 4b4ac871e146aee342dede7d3535692744a62741
 SHA512:
-  metadata.gz: a6483cceec52a6c9a4e5516de800acfbe29d515b1c26d59b104ae52562e83b51f0652f144f884d4583e16bd6754a944ff20ca66aecbfff81077b7a80fe7b6ebb
-  data.tar.gz: 69d6b66e9b6332e8e23b59638b1cb860bbfeed02648e3a2be68425c813effbf251fee54e4996283194a59c41364a0f458ff4983e9343e0897e606e99e43e6d62
+  metadata.gz: 89a93d2a533f92bf00b9b0a922bc9bd9ef6958d6f8585aaa98bfbdb29236ca5daddaa804ff49af149d8711c5452138262c4288a20145dc9b1ed849df7d4fbe6b
+  data.tar.gz: 6e40a3bfca72a94794af5cc3c3ca3469d01378b26224715b29b30a02445d6b6eec4d76787bf1d65b9313be79be733236eb892c522d6a5002b5602e3074852349

data/lib/client.rb

@@ -16,7 +16,20 @@ module Opendata
     end
 
     # Makes requests for 'logical collections' of Dataset resources (zero-to-many potential dataset resources)
-    # @param params [Hash] query parameters for Dataset resources
+    # @param [Hash] params query parameters for Dataset resources
+    # @option params [String] :q The query string for searching against datasets
+    # @option params [String] :include Comma-separate list of related resources to include. valid options are: 'organizations', 'groups', 'sites', 'items'
+    # @option params [String] :sort Sort criteria for the request. prepend a '-' to make the sort descending.
+    # @option params [Hash] :page Paging on the request. use { page: {size: Integer}} for page size and { page: { number: Integer}} for the page number 
+    # @option params [Hash] :fields The attribute subset you want returned for each object. Use like {fields: { datasets: 'title,url'}}
+    #
+    # @example Search for census datasets, 25 per page and include their related organizations and sites
+    #   client = Opendata.new('https://opendata.arcgis.com')
+    #   client.dataset_list(q: 'census', page: { size: 25 }, include: 'organizations,sites')
+    # @example Search for parcel datasets, second page, and include their related organizations and filter the dataset fields to title and url
+    #   client = Opendata.new('https://opendata.arcgis.com')
+    #   client.dataset_list(q: 'parcels', page: { number: 2 }, include: 'organizations', fields: { datasets: 'title,url'})
+    #
     # @return [Object] Faraday::Response object
     def dataset_list(params = {})
       connection.get(dataset_list_url(params))
@@ -24,6 +37,11 @@ module Opendata
 
     # Makes requests for 'logical collections' of Dataset resources (zero-to-many potential dataset resources)
     # @param params [Hash] query parameters for Dataset resources
+    # @example Get the request url for a search for census datasets, 25 per page and include their related organizations and sites
+    #   client = Opendata.new('https://opendata.arcgis.com')
+    #   client.dataset_list_url(q: 'census', page: { size: 25 }, include: 'organizations,sites')
+    #   #=> "/api/v2/datasets?q=census&page%5Bsize%5D=25&include=organizations%2Csites"
+    #
     # @return [String] request url based on the parameters specfied
     def dataset_list_url(params = {})
       DATASETS_API_PATH + param_to_query_string(params)
@@ -32,6 +50,14 @@ module Opendata
     # Makes requests for a 'logical object' for a specific Dataset resource (zero-to-one potential dataset resources)
     # @param id [String] The dataset id
     # @param params [Hash] Additional request parameters
+    #
+    # @example Retrive a dataset and related organizations and sites
+    #   client = Opendata.new('https://opendata.arcgis.com')
+    #   client.dataset_show('c92b122901ad40ee897d36b1a21f3187_11', include: 'organizations,sites')
+    #
+    # @example Retrive a dataset and specify a subset of fields (title,url,description,thumbnail)
+    #   client = Opendata.new('https://opendata.arcgis.com')
+    #   client.dataset_show('c92b122901ad40ee897d36b1a21f3187_11', fields: { datasets: 'title,url,description,thumbnail'})
     # @return [Object] Faraday::Response object
     def dataset_show(id, params = {})
       raise '#dataset_show must receive a dataset id' if id.nil?
@@ -41,6 +67,10 @@ module Opendata
     # Returns the url based on the id and url parameters specified
     # @param id [String] The dataset id
     # @param params [Hash] Additional request parameters
+    # @example Get the requets url for retrieving a single dataset and its related organizations and sites
+    #   client = Opendata.new('https://opendata.arcgis.com')
+    #   client.dataset_show_url('c92b122901ad40ee897d36b1a21f3187_11', include: 'organizations,sites')
+    #   #=> "/api/v2/datasets/c92b122901ad40ee897d36b1a21f3187_11?include=organizations%2Csites"
     # @return [String] request url based on id and parameters specified
     def dataset_show_url(id, params = {})
       DATASETS_API_PATH + "/#{id}" + param_to_query_string(params)

data/lib/version.rb

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

metadata

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