arcgis-opendata 0.0.7 → 0.0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60138b05e27da6ae4b594f7e9163ec8948857c67
-  data.tar.gz: a2147ca4484465843d83571a59c37f8b44d9bdcd
+  metadata.gz: 2f3dcff2ec138aef00ae48918e5fe8389a99e9fc
+  data.tar.gz: 9333a7b272da76251a2fa3d1e2400d824fead333
 SHA512:
-  metadata.gz: 82ee6831e97d899add047a487b3a91526de3ecfbd85fe3989ef9b58aa7ef9a8a16224fdbf81aeed9b9534467e853f10c019749c2b2f9a63aa577b8f3d7e899e9
-  data.tar.gz: d621db0cc6fecaa626bf9e0a9d224d0b1da812a6efa289d526f14c5c1cc1be17b539cbd2710374e3111f65208782aec6cee97838888cc5df19a45ce55ea7f3ca
+  metadata.gz: d73cb9010272f7bdd43cd439ee37f1f15be0a1dd36216ccb7d3070ba059c69eb3563d4dd0842f122017d8caccf3f8b7a83478b0bfe42945ee23a51121dbd7f04
+  data.tar.gz: 8c659ac374640042f4f5d701235925fd4e160462179245ae340bfcb8bb5ca96f8f4a682dc97a19ce5c963c2ee24fd942c494ff67d8fe15394d6d65c15b9c9e7d

data/README.md

@@ -29,6 +29,23 @@ Or install it yourself as:
 
     $ gem install arcgis-opendata
 
+## Local Docs
+
+If you want to generate docs locally you can do so with yardoc
+
+    $ bundle
+
+And then:
+
+    $ open doc/index.html
+
+Or:
+
+    $ open doc/Opendata.html
+
+
+You should be able to use the tabs on the top right corner to pull up a Class List, Method List, and File List.
+
 ## Usage
 
 The main class the gem provides is `Opendata::Client`, which can be used to query and fetch
@@ -64,8 +81,8 @@ 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'})` |
+| include   | String | comma-separate list of resources to 'side-load' | `client#dataset_show(include: 'organizations,sites')` |
+| fields    | nested | allows the client to specify a subset of attributes to be returned by the API | `client#dataset_show(fields: { datasets: 'title,url'})` |
 
 Make queries for datasets
 

data/lib/client.rb

@@ -16,12 +16,12 @@ module Opendata
     end
 
     # Makes requests for 'logical collections' of Dataset resources (zero-to-many potential dataset resources)
-    # @param [Hash] params query parameters for Dataset resources
+    # @param params [Hash] 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'}}
+    # @option params [Hash] :page Paging on the request. Use page[size] for the number of results per page and  page[number] for the page number 
+    # @option params [Hash] :fields The attribute subset you want returned for each object. 
     #
     # @example Search for census datasets, 25 per page and include their related organizations and sites
     #   client = Opendata.new('https://opendata.arcgis.com')

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Opendata
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.7.1'.freeze
 end

data/opendata.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["alexander_harris@esri.com"]
 
   spec.summary       = %q{Ruby Client for the ArcGIS Open Data API.}
-  spec.description   = %q{Ruby Client for the ArcGIS Open Data API built on top of Faraday.}
+  spec.description   = %q{Ruby Client for the ArcGIS Open Data API.}
   spec.homepage      = "https://github.com/esridc/arcgis-opendata.rb"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arcgis-opendata
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.7.1
 platform: ruby
 authors:
 - Alexander Harris
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.3
-description: Ruby Client for the ArcGIS Open Data API built on top of Faraday.
+description: Ruby Client for the ArcGIS Open Data API.
 email:
 - alexander_harris@esri.com
 executables: []