openaq-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec3e7d818623feb605f38ba22af1b82494a5d1f5e9297f9ea6f3f173805cd0e2
-  data.tar.gz: 91dc07c5d332c7f51e5ac548f19502507754e401d4123250ae8f188c151cd15c
+  metadata.gz: 422aae4f6327654c36b74182e29e7753a64998c44bdcbec5718ebbf6e9ba82e3
+  data.tar.gz: ff91978d5b94036ce1544c8f06465bbaff5c0ecb00e5c2f102141eecb24b5694
 SHA512:
-  metadata.gz: 76c35714120362bfd846e900037ac384e023c4d3c592bfe6614673fac2584719c4e9ccb64353a37080f0fc2ef08e698c078826171de2a5cce84a634d35e27692
-  data.tar.gz: 0ea92b91687f3ba1faf2fe327006263199a66bb4f2451187d6438a331a68c2f2521a19e9a0accdf58ef38b6e2f35d35c2c7c984f0603bd5d1325fcc1e4fe4078
+  metadata.gz: 34a1c54ef588e67402741379c7684cd921dec39b5f970f97ca3e4a694bad9e93f17493344afefbeb12be2492ec99ccab9f98cfa07d94454d26d7006911752882
+  data.tar.gz: 010d1f588d28bd448c6e1eddb2c3effc571c7fda10907ca4a0808321b55779362fc5d19d7b3bd7cadb5f8433fe8098df40098f6c2b5009926226c16c83001be3

data/lib/openaq.rb

@@ -1,5 +1,4 @@
-require 'json'
-require 'net/http'
+# frozen_string_literal: true
 
 require "openaq/client"
 require "openaq/version"

data/lib/openaq/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "openaq/networking"
 
 module Openaq
@@ -101,7 +103,7 @@ module Openaq
       # Provides data about individual measurements
       #
       # @param params please read the {https://docs.openaq.org Api Documentation}
-      # @return [<Hash>]
+      # @return [Array<Hash>]
 
       # @!method parameters(params = {})
       # Provides a simple listing of parameters within the platform.
@@ -125,7 +127,5 @@ module Openaq
         paginated_get("/#{name}", params)
       end
     end
-
-
   end
 end

data/lib/openaq/networking.rb

@@ -1,29 +1,29 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
 module Openaq
   module Networking
+    PARAMS = {}.freeze
 
     # @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)
-
-      begin
-        response = Net::HTTP.get_response(uri)
-      rescue Timeout::Error, Errno::ECONNREFUSED => e
-        raise Openaq::Error, e.message
-      end
-
-      parsed_response = JSON.parse(response.body) rescue { "results" => [] }
-      if !response.is_a?(Net::HTTPSuccess)
-        raise Openaq::Error, parsed_response["error"] || "Openaq responded with #{response.code}."
+    def get(path, params = PARAMS)
+      uri             = build_uri(path, params)
+      response        = Net::HTTP.get_response(uri)
+      parsed_response = JSON.parse(response.body)
+
+      if not response.is_a?(Net::HTTPSuccess)
+        err_msg = "#{parsed_response['error']}, #{parsed_response['message']}"
+        raise Openaq::Error, err_msg
       end
 
-      parsed_response["results"]
+      parsed_response['results']
     end
 
     # @raise [StopIteration] when there are no more results
-
-    def paginated_get(path, params={})
+    # @raise [Openaq::Error] if the request is not successful
+    def paginated_get(path, params = PARAMS)
       Enumerator.new do |yielder|
         page = 1
         params = { page: page }.merge(params)
@@ -40,5 +40,12 @@ module Openaq
       end.lazy
     end
 
+    private
+
+    def build_uri(path, params)
+      uri = URI(Openaq.url + path)
+      uri.query = URI.encode_www_form(params)
+      uri
+    end
   end
 end

data/lib/openaq/version.rb

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

data/spec/openaq_spec.rb

@@ -1,8 +1,7 @@
 RSpec.describe Openaq do
-
   it "has a version number" do
     expect(Openaq::VERSION).not_to be nil
-    expect(Openaq::VERSION).to eql "0.2.0"
+    expect(Openaq::VERSION).to eql "0.3.0"
   end
 
   describe ".client" do
@@ -10,5 +9,4 @@ RSpec.describe Openaq do
       expect(Openaq.client).to be_a(Openaq::Client)
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -1,17 +1,11 @@
-require "bundler/setup"
+require 'bundler/setup'
 require 'webmock/rspec'
-require "vcr"
 
 require File.expand_path('../../lib/openaq', __FILE__)
 
-VCR.configure do |config|
-  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
-  config.hook_into :webmock
-end
-
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
+  config.example_status_persistence_file_path = '.rspec_status'
 
   # Disable RSpec exposing methods globally on `Module` and `main`
   config.disable_monkey_patching!

data/spec/vcr_helper.rb

@@ -0,0 +1,6 @@
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openaq-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yiorgos Michokostas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,73 +16,73 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.8.3
 description: 'openaq-client is a Gem for the openaq.org JSON API
 
-'
+  '
 email:
 - michokostas@gmail.com
 executables: []
@@ -95,11 +95,12 @@ files:
 - lib/openaq/version.rb
 - spec/openaq_spec.rb
 - spec/spec_helper.rb
+- spec/vcr_helper.rb
 homepage: https://github.com/gmichokostas/openaq-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,11 +115,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby client for the OpenAQ API
 test_files:
-- spec/openaq_spec.rb
 - spec/spec_helper.rb
+- spec/openaq_spec.rb
+- spec/vcr_helper.rb