openaq-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53cc2eb6ba11d375be248fcb0390094518d4277615bea4b3c39e10fff0193afd
-  data.tar.gz: dd1a59b861c8f44a8b2ece8fc36c7925be0712ccc02441f716618ca6c5e04755
+  metadata.gz: ec3e7d818623feb605f38ba22af1b82494a5d1f5e9297f9ea6f3f173805cd0e2
+  data.tar.gz: 91dc07c5d332c7f51e5ac548f19502507754e401d4123250ae8f188c151cd15c
 SHA512:
-  metadata.gz: c9655a124435f37b4be0a34971c43b950b4f92b9b40975dba4ff29cb85be153c4ae9098645ff1fbe46d4e87738288693c6409bcaa34b4602563b9e25bfafc1bb
-  data.tar.gz: a43f13591566e50856860775050bffbaceaa9e96e288c4181b0b25b0faa089990acbe94dde3c562378b6a55b1776a4cee8247748102e14933f180ecca5976466
+  metadata.gz: 76c35714120362bfd846e900037ac384e023c4d3c592bfe6614673fac2584719c4e9ccb64353a37080f0fc2ef08e698c078826171de2a5cce84a634d35e27692
+  data.tar.gz: 0ea92b91687f3ba1faf2fe327006263199a66bb4f2451187d6438a331a68c2f2521a19e9a0accdf58ef38b6e2f35d35c2c7c984f0603bd5d1325fcc1e4fe4078

data/lib/openaq/client.rb

@@ -4,7 +4,7 @@ module Openaq
   class Client
     include Networking
 
-    [
+    ENDPOINTS = [
       :cities,
       :countries,
       :fetches,
@@ -13,15 +13,119 @@ module Openaq
       :measurements,
       :parameters,
       :sources,
-    ].each do |name|
-      define_method(name) do |params={}|
+    ].freeze
+
+    private_constant :ENDPOINTS
+
+    class << self
+
+      # @!method all_cities(params = {})
+      # Returns an Enumerator of {.cities}
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Enumerator]
+
+      # @!method all_countries(params = {})
+      # Returns an Enumerator of {.countries}
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Enumerator]
+
+      # @!method all_fetches(params = {})
+      # Returns an Enumerator of {.fetches}
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Enumerator]
+
+      # @!method all_latest(params = {})
+      # Returns an Enumerator of {.latest}
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Enumerator]
+
+      # @!method all_locations(params = {})
+      # Returns an Enumerator of {.locations}
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Enumerator]
+
+      # @!method all_measurements(params = {})
+      # Returns an Enumerator of {.measurements}
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Enumerator]
+
+      # @!method all_parameters(params = {})
+      # Returns an Enumerator of {.parameters}
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Enumerator]
+
+      # @!method all_sources(params = {})
+      # Returns an Enumerator of {.sources}
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Enumerator]
+
+      # @!method cities(params = {})
+      # Provides a simple listing of cities within the platform.
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Array<Hash>]
+
+      # @!method countries(params = {})
+      # Provides a simple listing of countries within the platform.
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Array<Hash>]
+
+      # @!method fetches(params = {})
+      # Providing data about individual fetch operations that are used to populate data in the platform.
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Array<Hash>]
+
+      # @!method latest(params = {})
+      # Provides the latest value of each available parameter for every location in the system.
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Array<Hash>]
+
+      # @!method locations(params = {})
+      # Provides a list of measurement locations and their meta data.
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Array<Hash>]
+
+      # @!method measurements(params = {})
+      # Provides data about individual measurements
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [<Hash>]
+
+      # @!method parameters(params = {})
+      # Provides a simple listing of parameters within the platform.
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Array<Hash>]
+
+      # @!method sources(params = {})
+      # Provides a list of data sources.
+      #
+      # @param params please read the {https://docs.openaq.org Api Documentation}
+      # @return [Array<Hash>]
+    end
+
+    ENDPOINTS.each do |name|
+      define_method(name) do |**params|
         get("/#{name}", params)
       end
 
-      define_method(:"all_#{name}") do |params={}|
+      define_method(:"all_#{name}") do |**params|
         paginated_get("/#{name}", params)
       end
     end
 
+
   end
 end

data/lib/openaq/networking.rb

@@ -1,6 +1,8 @@
 module Openaq
   module Networking
 
+    # @raise [Openaq::Error] if the request is not successful
+
     def get(path, params={})
       uri = URI(Openaq.url + path)
       uri.query = URI.encode_www_form(params)
@@ -19,6 +21,8 @@ module Openaq
       parsed_response["results"]
     end
 
+    # @raise [StopIteration] when there are no more results
+
     def paginated_get(path, params={})
       Enumerator.new do |yielder|
         page = 1

data/lib/openaq/version.rb

@@ -1,3 +1,3 @@
 module Openaq
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/spec/openaq_spec.rb

@@ -2,7 +2,7 @@ RSpec.describe Openaq do
 
   it "has a version number" do
     expect(Openaq::VERSION).not_to be nil
-    expect(Openaq::VERSION).to eql "0.1.1"
+    expect(Openaq::VERSION).to eql "0.2.0"
   end
 
   describe ".client" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openaq-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Yiorgos Michokostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-26 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler