sau-ruby 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ed9d8e9bb5ff133ec469fac6f5c876a333ada49
+  data.tar.gz: 0a7485b1a6c1ae69851c6818770eb040fc343fc5
+SHA512:
+  metadata.gz: 1c37c1dbedd65c9f700f0d5c8d6bda18f11e9eb8d4f94ea482f0dd288b67c14e773b48bb269c9a6efe512e0b0cd56a72b030c3a816bfc7b1e5b3aa815631051e
+  data.tar.gz: feb7a2c119601cd7ff88d042022ba027b1b656207204d919c3ac9b59aef57ef84295140bec06074532bb23226cc451711198f2f31d86e078df83b324e8de5c91

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015, Vulcan Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+## SeaAroundUs API Wrapper
+Ruby wrapper for the [Sea Around Us API](https://github.com/SeaAroundUs/sau-web-mt).
+
+
+### Installation
+```bash
+$ gem install sau-ruby
+```
+
+
+### Example usage
+```ruby
+# include the helper library
+require 'sau-ruby'
+
+# get list of EEZs
+eezs = SAU.get_regions('eez')
+
+# get details for a single EEZ
+brazil = eezs.get_by_title('Brazil (mainland)')
+brazil.get_detail
+
+# alternative way without getting the region list
+brazil = SAU.get_region_detail('eez', 76)
+
+# using LMEs for the next example
+lmes = SAU.get_regions('lme')
+
+# sample set of parameters for catch data
+catch_data_params = {
+  measure: 'tonnage',
+  dimension: 'taxon',
+  sciname: true,
+  limit: 10
+}
+
+# get catch data for a single LME
+north_sea = lmes.get_by_title('North Sea')
+north_sea.get_data(catch_data_params)
+
+# alternative way without getting the region list
+north_sea.get_region_data('lme', 22, catch_data_params)
+```
+
+
+### Available parameters
+Regions:
+* eez
+* lme
+* rfmo
+* fishing-entity
+
+Measures:
+* tonnage
+* value
+
+Dimensions:
+* taxon
+* commercialgroup
+* functionalgroup
+* country
+* sector
+* catchtype
+* reporting-status
+
+Other catch data parameters:
+* limit (integer)
+* sciname (boolean)

data/lib/sau/region.rb

@@ -0,0 +1,25 @@
+module SAU
+  class Region
+    def initialize(props)
+      @props = props
+    end
+
+    def get_detail
+      @props.merge!(SAU.call_api("#{region}/#{id}"))
+      self
+    end
+
+    def get_data(params)
+      url = "#{region}/#{params[:measure]}/#{params[:dimension]}/?region_id=#{id}&"
+      url += params.select { |param| !%i(measure dimension).include?(param) }.map { |k,v| "#{k}=#{v}" }.join('&')
+      @props[:data] = SAU.call_api(url)
+      self
+    end
+
+    def method_missing(meth, *args)
+      return @props[meth] if @props.include?(meth)
+      super(meth, args) unless meth.to_s =~ /=$/
+      @props[meth.to_s[0...-1].to_sym] = args.first
+    end
+  end
+end

data/lib/sau/regions.rb

@@ -0,0 +1,15 @@
+module SAU
+  class Regions
+    attr_reader :regions
+
+    def initialize(regions)
+      @regions = regions
+    end
+
+    def method_missing(meth, *args)
+      super(meth, args) unless meth.to_s =~ /^get_by_(\w+)$/
+      value, prop = args.first, $1
+      @regions.find { |region| region.send(prop.to_sym) == value }
+    end
+  end
+end

data/lib/sau/version.rb

@@ -0,0 +1,3 @@
+module SAU
+  VERSION = '1.0.1'
+end

data/lib/sau.rb

@@ -0,0 +1,29 @@
+require 'bundler/setup'
+Bundler.require(:default)
+require_relative 'sau/regions'
+require_relative 'sau/region'
+
+module SAU
+  BASE_URL = 'http://api.seaaroundus.org/api/v1/'
+
+  class << self
+    def get_regions(region_name)
+      regions = call_api("#{region_name}/?nospatial=true")
+      Regions.new(regions.map { |region| region[:region] = region_name; Region.new(region) })
+    end
+
+    def get_region_detail(region_name, region_id)
+      Region.new(region: region_name, id: region_id).get_detail
+    end
+
+    def get_region_data(region_name, region_id, params)
+      Region.new(region: region_name, id: region_id).get_data(params)
+    end
+
+    def call_api(url)
+      response = RestClient.get(BASE_URL + url)
+      raise 'Error: ' + response.to_s unless response.code == 200
+      JSON.parse(response.to_s, symbolize_names: true)[:data]
+    end
+  end
+end

data/spec/sau/region_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../spec_helper'
+
+module SAU
+  describe Region do
+    describe :get_detail do
+      it 'gets region details' do
+        region = Region.new({ region: TEST_REGION, id: TEST_REGION_ID, foo: 'baz' })
+        stub = stub_request(:get, "#{BASE_URL}#{TEST_REGION}/#{TEST_REGION_ID}").
+            to_return(body: { data: TEST_REGION_DETAIL }.to_json)
+        region = region.get_detail
+        expect(stub).to have_been_requested
+        expect(region.instance_variable_get(:@props)).to eq TEST_REGION_DETAIL.merge({ region: TEST_REGION })
+      end
+    end
+
+    describe :get_data do
+      it 'gets region data for a set of params' do
+        url = "#{BASE_URL}#{TEST_REGION}/#{TEST_DATA_PARAMS[:measure]}" +
+          "/#{TEST_DATA_PARAMS[:dimension]}/?region_id=#{TEST_REGION_ID}&" +
+          "limit=#{TEST_DATA_PARAMS[:limit]}&sciname=#{TEST_DATA_PARAMS[:sciname]}"
+        region = Region.new({ region: TEST_REGION, id: TEST_REGION_ID })
+        stub = stub_request(:get, url).
+            to_return(body: { data: 'testdata' }.to_json)
+        region = region.get_data(TEST_DATA_PARAMS)
+        expect(stub).to have_been_requested
+        expect(region.instance_variable_get(:@props)[:data]).to eq 'testdata'
+      end
+    end
+
+    describe :method_missing do
+      let(:region) { Region.new(foo: 'bar') }
+
+      it 'returns a value if the property exists' do
+        expect(region.foo).to eq 'bar'
+      end
+
+      it 'assigns a new value if the method ends with =' do
+        region.foo = 'baz'
+        expect(region.foo).to eq 'baz'
+      end
+
+      it 'raises a NoMethodError error if the property does not exist' do
+        expect { region.bar }.to raise_error NoMethodError
+      end
+    end
+  end
+end

data/spec/sau/regions_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+
+module SAU
+  describe Regions do
+    describe :method_missing do
+      it 'returns regions by field if that field exists' do
+        test_region = Object.new
+        expect(test_region).to receive(:foo).and_return('bar')
+        regions = Regions.new([test_region])
+        expect(regions.get_by_foo('bar')).to be test_region
+      end
+
+      it 'raises a NoMethodError error if the field does not exist' do
+        test_region = Object.new
+        regions = Regions.new([test_region])
+        expect { regions.get_by_foo('bar') }.to raise_error NoMethodError
+      end
+    end
+  end
+end

data/spec/sau_spec.rb

@@ -0,0 +1,42 @@
+require_relative 'spec_helper'
+
+module SAU
+  describe :get_regions do
+    it 'gets the regions of a given type' do
+      stub_request(:get, "#{BASE_URL}#{TEST_REGION}/?nospatial=true").
+          to_return(body: { data: [ TEST_REGION_DETAIL ]}.to_json)
+      regions = SAU.get_regions(TEST_REGION)
+      expect(regions).to be_instance_of Regions
+      expect(regions.regions.first).to be_instance_of Region
+      expect(regions.regions.first.region).to eq TEST_REGION
+    end
+  end
+
+  describe :get_region_detail do
+    it 'gets the region detail for a specified type and id' do
+      expect_any_instance_of(Region).to receive(:get_detail)
+      SAU.get_region_detail(TEST_REGION, TEST_REGION_ID)
+    end
+  end
+
+  describe :get_region_data do
+    it 'gets the region data for a specified type and id with params' do
+      expect_any_instance_of(Region).to receive(:get_data)
+      SAU.get_region_data(TEST_REGION, TEST_REGION_ID, TEST_DATA_PARAMS)
+    end
+  end
+
+  describe :call_api do
+    it 'calls the API' do
+      stub = stub_request(:get, "#{BASE_URL}foobar").to_return(body: { data: 'success' }.to_json)
+      expect(SAU.call_api('foobar')).to eq 'success'
+      expect(stub).to have_been_requested
+    end
+
+    it 'raises an error for non 200 status' do
+      stub = stub_request(:get, "#{BASE_URL}foobar").to_return(status: 500, body: 'error')
+      expect { SAU.call_api('foobar') }.to raise_error(RestClient::InternalServerError)
+      expect(stub).to have_been_requested
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler.require(:test)
+require_relative '../lib/sau'
+
+TEST_REGION = 'reg'
+TEST_REGION_ID = 42
+TEST_REGION_TITLE = 'Test Region'
+TEST_DATA_PARAMS = { measure: 'mes', dimension: 'dim', limit: 10, sciname: true }
+TEST_REGION_DETAIL = { id: TEST_REGION_ID, title: TEST_REGION_TITLE, foo: 'bar' }

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: sau-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Robert Scott Reis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sau.rb
+- lib/sau/region.rb
+- lib/sau/regions.rb
+- lib/sau/version.rb
+- spec/sau/region_spec.rb
+- spec/sau/regions_spec.rb
+- spec/sau_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/seaaroundus/sau-ruby
+licenses:
+- SEE LICENSE IN LICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Sea Around Us API
+test_files: []