soda-ruby 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/soda/version.rb +1 -1
- metadata +4 -6
- data/README.mkd +0 -74
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 778c87a4294f9311d752ddcc8df487549b84c467f10e88d73981694ed3599790
|
4
|
+
data.tar.gz: 898adb8fa65dd8f869429b9f72c9199039631053838132e60fb24880cb92b6f7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 04dc1e34fb728e0a6e76b5ab4662eeef5ddd4f60740131829213f272d68c983fdf0f6b9511799610aa9279724b3b007e4445508519f7f04a0285f5c7492fb7bf
|
7
|
+
data.tar.gz: 686adfbd9c0efa77bf2b5c86d42d131ac28793b7cab2f35459ce912c67b62d5b83a9aafd284efba564ecff590f984af0f9add23956c54851613302024f522676
|
data/lib/soda/version.rb
CHANGED
metadata
CHANGED
@@ -1,15 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: soda-ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Chris Metcalf
|
8
|
-
- Dominic Cicilio
|
9
8
|
autorequire:
|
10
9
|
bindir: bin
|
11
10
|
cert_chain: []
|
12
|
-
date:
|
11
|
+
date: 2020-06-23 00:00:00.000000000 Z
|
13
12
|
dependencies:
|
14
13
|
- !ruby/object:Gem::Dependency
|
15
14
|
name: hashie
|
@@ -181,13 +180,12 @@ dependencies:
|
|
181
180
|
version: '0'
|
182
181
|
description: A simple wrapper for SODA 2.0. Includes an OmniAuth provider for OAuth
|
183
182
|
2.0
|
184
|
-
email:
|
183
|
+
email: chris.metcalf@socrata.com
|
185
184
|
executables: []
|
186
185
|
extensions: []
|
187
186
|
extra_rdoc_files: []
|
188
187
|
files:
|
189
188
|
- LICENSE
|
190
|
-
- README.mkd
|
191
189
|
- lib/omniauth-socrata.rb
|
192
190
|
- lib/soda.rb
|
193
191
|
- lib/soda/client.rb
|
@@ -212,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
212
210
|
version: 1.3.6
|
213
211
|
requirements: []
|
214
212
|
rubyforge_project: soda-ruby
|
215
|
-
rubygems_version: 2.
|
213
|
+
rubygems_version: 2.7.6
|
216
214
|
signing_key:
|
217
215
|
specification_version: 4
|
218
216
|
summary: Ruby for SODA 2.0
|
data/README.mkd
DELETED
@@ -1,74 +0,0 @@
|
|
1
|
-
|
2
|
-
[](https://ci.appveyor.com/project/chrismetcalf/soda-ruby)
|
3
|
-
[](https://travis-ci.org/socrata/soda-ruby)
|
4
|
-
|
5
|
-
For more details and for documentation, check out <http://socrata.github.io/soda-ruby> or our [developer portal](http://dev.socrata.com).
|
6
|
-
|
7
|
-
## Installation
|
8
|
-
|
9
|
-
SODA is distributed as a gem, which is how it should be used in your app.
|
10
|
-
|
11
|
-
Include the gem and hashie in your Gemfile:
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
gem 'soda-ruby', :require => 'soda'
|
15
|
-
```
|
16
|
-
|
17
|
-
### Important Note!
|
18
|
-
|
19
|
-
In order to access the SODA API via HTTPS, clients must now [support the Server Name Indication (SNI)](https://dev.socrata.com/changelog/2016/08/24/sni-now-required-for-https-connections.html) extension to the TLS protocol. What does this mean? It means that if you're using `soda-ruby`, you must [use Ruby 2.0.0 or above](https://en.wikipedia.org/wiki/Server_Name_Indication), as that is when `net/http` introduced support for SNI. 2.0.0 was released in 2011, so most up-to-date platforms will be on version 2.0 or greater.
|
20
|
-
|
21
|
-
## Quick Start
|
22
|
-
|
23
|
-
Create a new client. Register for an application token at <http://dev.socrata.com/register>.
|
24
|
-
|
25
|
-
```ruby
|
26
|
-
client = SODA::Client.new({:domain => "explore.data.gov", :app_token => "CGxadgoQlgQSev4zyUh5aR5J3"})
|
27
|
-
```
|
28
|
-
|
29
|
-
Issue a filter query. `644b-gaut` is the identifier for the dataset we want to access.
|
30
|
-
|
31
|
-
### As of version 1.0.0+
|
32
|
-
|
33
|
-
The return object is the complete response object with a pre parsed body. The response.body object is an array of [Hashie::Mash].
|
34
|
-
|
35
|
-
If you are upgrading from a version < 1.0.0 The previous object returned is now the response.body object.
|
36
|
-
|
37
|
-
### Prior to version 1 (<1.0.0)
|
38
|
-
|
39
|
-
The return object is an array of [Hashie::Mash] that represents the body of the response.
|
40
|
-
|
41
|
-
(https://github.com/intridea/hashie) objects:
|
42
|
-
|
43
|
-
```ruby
|
44
|
-
response = client.get("644b-gaut", {"$limit" => 1, :namelast => "WINFREY", :namefirst => "OPRAH"})
|
45
|
-
|
46
|
-
#=> [#<Hashie::Mash appt_end_date="12/3/09 23:59" appt_made_date="12/2/09 18:05" appt_start_date="12/3/09 9:30" caller_name_first="SALLY" caller_name_last="ARMBRUSTER" last_updatedby="J7" lastentrydate="12/2/09 18:05" meeting_loc="WH" meeting_room="DIP ROOM" namefirst="OPRAH" namelast="WINFREY" post="WIN" release_date=1269586800 terminal_suffix="J7" total_people="10" type_of_access="VA" uin="U60816" visitee_namefirst="SEMONTI" visitee_namelast="STEPHENS">]
|
47
|
-
```
|
48
|
-
|
49
|
-
You can use other simple query SoQL methods found here: <http://dev.socrata.com/docs/queries.html>
|
50
|
-
|
51
|
-
```ruby
|
52
|
-
client = SODA::Client.new({:domain => "soda.demo.socrata.com"})
|
53
|
-
magnitude_response = client.get("4tka-6guv", {"$where" => "magnitude > '3.0'"})
|
54
|
-
|
55
|
-
#=> [#<Hashie::Mash datetime="2012-09-14T09:28:55" depth="20" earthquake_id="12258012" location=#<Hashie::Mash latitude="19.7859" longitude="-64.0849" needs_recoding=false> magnitude="3.1" number_of_stations="6" region="north of the Virgin Islands" source="pr" version="0">, #<Hashie::Mash datetime="2012-09-14T07:58:39" depth="74" earthquake_id="12258011" location=#<Hashie::Mash latitude="19.5907" longitude="-64.1723" needs_recoding=false> magnitude="3.3" number_of_stations="4" region="Virgin Islands region" source="pr" version="0">, ... ]
|
56
|
-
|
57
|
-
datetime_response = client.get("4tka-6guv", {"$where" => "datetime > '2012-09-14T09:28:55' AND datetime < '2012-12-25T09:00:00'"})
|
58
|
-
|
59
|
-
#=> [#<Hashie::Mash datetime="2012-09-14T10:10:19" depth="8.2" earthquake_id="00388609" location=#<Hashie::Mash latitude="36.9447" longitude="-117.6778" needs_recoding=false> magnitude="1.7" number_of_stations="29" region="Northern California" source="nn" version="9">, #<Hashie::Mash datetime="2012-09-14T10:06:11" depth="6.4" earthquake_id="00388607" location=#<Hashie::Mash latitude="36.9417" longitude="-117.6903" needs_recoding=false> magnitude="1.7" number_of_stations="29" region="Central California" source="nn" version="9">, ... ]
|
60
|
-
```
|
61
|
-
|
62
|
-
You can also provide a full URI to an API endpoint instead of specifying the ID. Just copy and paste the dataset URI from the API documentation!
|
63
|
-
|
64
|
-
```ruby
|
65
|
-
client = SODA::Client.new({:domain => "soda.demo.socrata.com"})
|
66
|
-
magnitude_response = client.get("https://soda.demo.socrata.com/resource/4tka-6guv.json", {"$where" => "magnitude > '3.0'"})
|
67
|
-
```
|
68
|
-
|
69
|
-
All the field names have built in getter methods since the objects are Hashie::Mashes.
|
70
|
-
|
71
|
-
```ruby
|
72
|
-
magnitude_response.first.number_of_stations #=> "6"
|
73
|
-
```
|
74
|
-
*Note that the return value is a string object.*
|