arcgis-opendata 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba6ceb9cbfbe7cb039b3ae16bdb3d1a72017b298
-  data.tar.gz: 1d7152b866a38919b88f891da6204a45435fc186
+  metadata.gz: 2dc43e610cc33ebbdd228a80ac14d73cb7b06cca
+  data.tar.gz: 3a500b8608c83c8dcc4a7c0c7823c63c8eb7d867
 SHA512:
-  metadata.gz: d5284c9a51dd63107f82cf263853e535680829a2eef263044d4d3053a490eefcd79723aa102e461865903e71bec7902fe70466093128d3c75c25fd651ba4c995
-  data.tar.gz: 4ccda693138e0896ed12f37587b6da2bd57410ef5ea7257743dc79e50be67e60be4271459832304a01dc20b3f26871397b451efca3a219c2d557da69b2c36227
+  metadata.gz: 61621ee8e90785dba3e3391546f9331bf71128fa60f581add5925290186908243d19a39af2d75c7ea83836a142e8dd72cb73b0e6507f03b5d7b1f580beb121d8
+  data.tar.gz: 46d0888becf27bf9cd0256a3e8f5e6fd74c585468e367f1bc4ff2e8dfa5ef33f4eee4eaa1cbeb71d6088776d3feb0f9bb8856aa223087241e4bffecaffcc4708

data/lib/client.rb

@@ -3,21 +3,29 @@ require 'uri'
 
 module Opendata
 
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 
   class Client
-    
+
+    # Constructor for Opendata::Client instances
+    # @param url [String] the base url to the open data API
+    # @param options [Hash] assorted options for instantiating the Opendata::Client instance
+    # @return [Object] the Opendata::Client instance which is a simple wrapper around a Faraday::Connection instance
     def initialize(url = nil, options = {})
       opts = options.merge(DEFAULT_HEADERS)
       @connection = Faraday.new(url, opts)
     end
 
-    # For making requets at /api/v2/datasets
+    # Makes requests for 'logical collections' of Dataset resources (zero-to-many potential dataset resources)
+    # @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))
     end
 
-    # For making requests at /api/v2/datasets/{:id}
+    # 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
     def dataset_show(id, params = {})
       raise '#dataset_show must receive a dataset id' if id.nil?
 

data/lib/opendata.rb

@@ -2,7 +2,11 @@ require "client"
 
 module Opendata
 
-  # Factory method to instantiate an Opendata::Client instance
+  # Returns a new Opendata::Client instance
+  #
+  # @param url [String] the base url to the open data API
+  # @param options [Hash] assorted options for instantiating the Opendata::Client instance
+  # @return [Object] the Opendata::Client instance
   class << self
     def new(url, options={})
       Client.new(url, options)

metadata

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