openaq-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53cc2eb6ba11d375be248fcb0390094518d4277615bea4b3c39e10fff0193afd
+  data.tar.gz: dd1a59b861c8f44a8b2ece8fc36c7925be0712ccc02441f716618ca6c5e04755
+SHA512:
+  metadata.gz: c9655a124435f37b4be0a34971c43b950b4f92b9b40975dba4ff29cb85be153c4ae9098645ff1fbe46d4e87738288693c6409bcaa34b4602563b9e25bfafc1bb
+  data.tar.gz: a43f13591566e50856860775050bffbaceaa9e96e288c4181b0b25b0faa089990acbe94dde3c562378b6a55b1776a4cee8247748102e14933f180ecca5976466

data/lib/openaq.rb

@@ -0,0 +1,19 @@
+require 'json'
+require 'net/http'
+
+require "openaq/client"
+require "openaq/version"
+
+module Openaq
+  class Error < StandardError; end
+
+  class << self
+    def client
+      @client ||= Client.new
+    end
+
+    def url
+      'https://api.openaq.org/v1'
+    end
+  end
+end

data/lib/openaq/client.rb

@@ -0,0 +1,27 @@
+require "openaq/networking"
+
+module Openaq
+  class Client
+    include Networking
+
+    [
+      :cities,
+      :countries,
+      :fetches,
+      :latest,
+      :locations,
+      :measurements,
+      :parameters,
+      :sources,
+    ].each do |name|
+      define_method(name) do |params={}|
+        get("/#{name}", params)
+      end
+
+      define_method(:"all_#{name}") do |params={}|
+        paginated_get("/#{name}", params)
+      end
+    end
+
+  end
+end

data/lib/openaq/networking.rb

@@ -0,0 +1,40 @@
+module Openaq
+  module Networking
+
+    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}."
+      end
+
+      parsed_response["results"]
+    end
+
+    def paginated_get(path, params={})
+      Enumerator.new do |yielder|
+        page = 1
+        params = { page: page }.merge(params)
+
+        loop do
+          response = get(path, params)
+          if !response.empty?
+            response.map { |item| yielder << item }
+            params[:page] += 1
+          else
+            raise StopIteration
+          end
+        end
+      end.lazy
+    end
+
+  end
+end

data/lib/openaq/version.rb

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

data/spec/openaq_spec.rb

@@ -0,0 +1,14 @@
+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"
+  end
+
+  describe ".client" do
+    it "should create and return a new client" do
+      expect(Openaq.client).to be_a(Openaq::Client)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+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"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: openaq-client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Yiorgos Michokostas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 'openaq-client is a Gem for the openaq.org JSON API
+
+'
+email:
+- michokostas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/openaq.rb
+- lib/openaq/client.rb
+- lib/openaq/networking.rb
+- lib/openaq/version.rb
+- spec/openaq_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gmichokostas/openaq-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby client for the OpenAQ API
+test_files:
+- spec/openaq_spec.rb
+- spec/spec_helper.rb