arcgis-opendata 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c065d52e32cc272d56f7a04f117ab89cce21ac7
-  data.tar.gz: 95037aa5f76d2c87448ac6d7da9915a0074daf33
+  metadata.gz: 45bd9d987a78c6dd42d3990c6dd2f23976afb633
+  data.tar.gz: 8a70222a96289c8832b1f6e97720e014066ffeb6
 SHA512:
-  metadata.gz: 6006728d0c3a4675070a17d74c076c303336f7c1b21e3f590bfcecb35914b08669d5e7caccee2989bccfcd59b1e213c551abb3a383efaa37a3fd84cecb933eed
-  data.tar.gz: 0c4404deaa18ad1fbb28b5b7488bec89d16bff5c55d3e255eeba34480d8b98bfe076532ce945daf1a79289c059abf44d86265ccafd8ddc1bc66826ffe22c419e
+  metadata.gz: 9c9666b49c7acd7dc8421fd0d10b9aebd280ea9e3c5e6a0fc3a4bd0dce5cd48e43829ef8d168edb07b3fb49e471004762dc14c137c6b62d97d82c8567d1559f1
+  data.tar.gz: 64b8053ab24c769b06fae0376b0bd851c40f39bac1ca39710cd30ee70ded33058b9f9a8bce6ebef32c0652f913d1bd2b13d7ba3c7f8a9851364a4de56a36549a

data/README.md

@@ -37,6 +37,30 @@ You can also instantiate an instance directly from the Opendata module
 client = Opendata.new('https://opendata.arcgis.com')
 ```
 
+### Example Dataset Queries
+
+Search Parameters are JSONAPI compliant. To learn more about the JSONAPI parameters go to their section
+about [fetching data](http://jsonapi.org/format/#fetching) at jsonapi.org
+
+Parameters supported for `dataset_list`
+
+| Parameter | Type | Description | Usage |
+| --------- | ---- | ----------- | ----- |
+| q         | String | query to perform against the datasets resource | `client#dataset_list(q: 'census')` |
+| sort      | String | specifies sort criteria. prepend with a '-' to signify a descending sort| `client#dataset_list(sort: '-updated_at')` |
+| include   | String | comma-separate list of resources to 'side-load' | `client#dataset_list(include: 'organizations,sites')` |
+| fields    | nested | allows the client to specify a subset of attributes to be returned by the API | `client#dataset_list(fields: { datasets: 'title,url'})` |
+| filter    | nested | filter the datasets on filterable attributes | `client#dataset_list(filter: { content: 'spatial dataset'})` |
+| page      | nested | specify paging parameters. | `client#dataset_list(page: { size: 25, number: 2})`
+
+Parameters supported for `dataset_show`
+
+| Parameter | Type | Description | Usage |
+| --------- | ---- | ----------- | ----- |
+| include   | String | comma-separate list of resources to 'side-load' | `client#dataset_list(include: 'organizations,sites')` |
+| fields    | nested | allows the client to specify a subset of attributes to be returned by the API | `client#dataset_list(fields: { datasets: 'title,url'})` |
+
+
 Make queries for datasets
 ```ruby
 client = Opendata.new('https://opendata.arcgis.com')

data/lib/client.rb

@@ -1,10 +1,9 @@
+require 'version'
 require 'faraday'
 require 'uri'
 
 module Opendata
 
-  VERSION = '0.0.5'.freeze
-
   class Client
 
     # Constructor for Opendata::Client instances
@@ -20,16 +19,31 @@ module Opendata
     # @param params [Hash] query parameters for Dataset resources
     # @return [Object] Faraday::Response object
     def dataset_list(params = {})
-      connection.get(DATASETS_API_PATH + param_to_query_string(params))
+      connection.get(dataset_list_request(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 = {})
+      DATASETS_API_PATH + param_to_query_string(params)
     end
 
     # 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
+    # @return [Object] Faraday::Response object
     def dataset_show(id, params = {})
       raise '#dataset_show must receive a dataset id' if id.nil?
+      connection.get(dataset_show_url(id, params))
+    end
 
-      connection.get(DATASETS_API_PATH + "/#{id}" + param_to_query_string(params))
+    # Returns the url based on the id and url parameters specified
+    # @param id [String] The dataset id
+    # @param params [Hash] Additional request parameters
+    # @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)
     end
 
     def param_to_query_string(params)

data/lib/version.rb

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

data/opendata.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'opendata'
+require 'version'
 
 Gem::Specification.new do |spec|
   spec.name          = "arcgis-opendata"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arcgis-opendata
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Alexander Harris
@@ -97,6 +97,7 @@ files:
 - bin/setup
 - lib/client.rb
 - lib/opendata.rb
+- lib/version.rb
 - opendata.gemspec
 homepage: https://github.com/esridc/arcgis-opendata.rb
 licenses: