arcgis-opendata 0.0.7 → 0.0.7.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +19 -2
- data/lib/client.rb +3 -3
- data/lib/version.rb +1 -1
- data/opendata.gemspec +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2f3dcff2ec138aef00ae48918e5fe8389a99e9fc
|
4
|
+
data.tar.gz: 9333a7b272da76251a2fa3d1e2400d824fead333
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d73cb9010272f7bdd43cd439ee37f1f15be0a1dd36216ccb7d3070ba059c69eb3563d4dd0842f122017d8caccf3f8b7a83478b0bfe42945ee23a51121dbd7f04
|
7
|
+
data.tar.gz: 8c659ac374640042f4f5d701235925fd4e160462179245ae340bfcb8bb5ca96f8f4a682dc97a19ce5c963c2ee24fd942c494ff67d8fe15394d6d65c15b9c9e7d
|
data/README.md
CHANGED
@@ -29,6 +29,23 @@ Or install it yourself as:
|
|
29
29
|
|
30
30
|
$ gem install arcgis-opendata
|
31
31
|
|
32
|
+
## Local Docs
|
33
|
+
|
34
|
+
If you want to generate docs locally you can do so with yardoc
|
35
|
+
|
36
|
+
$ bundle
|
37
|
+
|
38
|
+
And then:
|
39
|
+
|
40
|
+
$ open doc/index.html
|
41
|
+
|
42
|
+
Or:
|
43
|
+
|
44
|
+
$ open doc/Opendata.html
|
45
|
+
|
46
|
+
|
47
|
+
You should be able to use the tabs on the top right corner to pull up a Class List, Method List, and File List.
|
48
|
+
|
32
49
|
## Usage
|
33
50
|
|
34
51
|
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`
|
|
64
81
|
|
65
82
|
| Parameter | Type | Description | Usage |
|
66
83
|
| --------- | ---- | ----------- | ----- |
|
67
|
-
| include | String | comma-separate list of resources to 'side-load' | `client#
|
68
|
-
| fields | nested | allows the client to specify a subset of attributes to be returned by the API | `client#
|
84
|
+
| include | String | comma-separate list of resources to 'side-load' | `client#dataset_show(include: 'organizations,sites')` |
|
85
|
+
| fields | nested | allows the client to specify a subset of attributes to be returned by the API | `client#dataset_show(fields: { datasets: 'title,url'})` |
|
69
86
|
|
70
87
|
Make queries for datasets
|
71
88
|
|
data/lib/client.rb
CHANGED
@@ -16,12 +16,12 @@ module Opendata
|
|
16
16
|
end
|
17
17
|
|
18
18
|
# Makes requests for 'logical collections' of Dataset resources (zero-to-many potential dataset resources)
|
19
|
-
# @param [Hash]
|
19
|
+
# @param params [Hash] query parameters for Dataset resources
|
20
20
|
# @option params [String] :q The query string for searching against datasets
|
21
21
|
# @option params [String] :include Comma-separate list of related resources to include. valid options are: 'organizations', 'groups', 'sites', 'items'
|
22
22
|
# @option params [String] :sort Sort criteria for the request. prepend a '-' to make the sort descending.
|
23
|
-
# @option params [Hash] :page Paging on the request.
|
24
|
-
# @option params [Hash] :fields The attribute subset you want returned for each object.
|
23
|
+
# @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
|
24
|
+
# @option params [Hash] :fields The attribute subset you want returned for each object.
|
25
25
|
#
|
26
26
|
# @example Search for census datasets, 25 per page and include their related organizations and sites
|
27
27
|
# client = Opendata.new('https://opendata.arcgis.com')
|
data/lib/version.rb
CHANGED
data/opendata.gemspec
CHANGED
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
|
|
10
10
|
spec.email = ["alexander_harris@esri.com"]
|
11
11
|
|
12
12
|
spec.summary = %q{Ruby Client for the ArcGIS Open Data API.}
|
13
|
-
spec.description = %q{Ruby Client for the ArcGIS Open Data API
|
13
|
+
spec.description = %q{Ruby Client for the ArcGIS Open Data API.}
|
14
14
|
spec.homepage = "https://github.com/esridc/arcgis-opendata.rb"
|
15
15
|
spec.license = "MIT"
|
16
16
|
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: arcgis-opendata
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.7
|
4
|
+
version: 0.0.7.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Alexander Harris
|
@@ -80,7 +80,7 @@ dependencies:
|
|
80
80
|
- - "~>"
|
81
81
|
- !ruby/object:Gem::Version
|
82
82
|
version: 0.10.3
|
83
|
-
description: Ruby Client for the ArcGIS Open Data API
|
83
|
+
description: Ruby Client for the ArcGIS Open Data API.
|
84
84
|
email:
|
85
85
|
- alexander_harris@esri.com
|
86
86
|
executables: []
|