ecoportal-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b99e6fa7d712d6b40f6c3a838aadecacd2ecf2d3b12100975a50b2811927872
+  data.tar.gz: d11092f6185355695b1f49aa3d5a37fecefbc6c874a68bd2f1d4df3bce8476c9
+SHA512:
+  metadata.gz: 4b30f4789e25beb110b599f93958ee019052827c3b0e75337071c7aa05bc5dd8dc8002f3f95b1174260379da895b677c84167404b6e486842bee380e8d1a83ab
+  data.tar.gz: b722086c23c0331adc7b7335e718598d584b612fa9692d4f59ecb7886af04fe803ece3449c8f921f83f4080880a1c516e53493408e21f80c5b3aaabedfb7a483

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+scratch.rb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ecoportal-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    ecoportal-api (0.1.0)
+      http (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http (3.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ecoportal-api!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,34 @@
+# Ecoportal::API
+
+This is a basic collection of helpers that can be used to interact with the
+[ecoPortal](https://www.ecoportal.com) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecoportal-api', require: %w[ecoportal/api]
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ecoportal-api
+
+## Usage
+
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ecoportal/ecoportal-api.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ecoportal/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ecoportal-api.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ecoportal/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecoportal-api"
+  spec.version       = Ecoportal::API::VERSION
+  spec.authors       = ["Tapio Saarinen"]
+  spec.email         = ["tapio@ecoportal.co.nz"]
+
+  spec.summary       = %q{A collection of helpers for interacting with the ecoPortal MS's various APIs}
+  spec.homepage      = "https://www.ecoportal.com"
+  spec.licenses      = %w[MIT]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'http', '~> 3'
+end

data/lib/ecoportal/api.rb

@@ -0,0 +1,11 @@
+require "cgi"
+require "ecoportal/api/version"
+
+module Ecoportal
+  module API
+  end
+end
+
+require "ecoportal/api/common"
+require "ecoportal/api/v1"
+require "ecoportal/api/internal"

data/lib/ecoportal/api/common.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    module Common
+    end
+  end
+end
+require 'ecoportal/api/common/client'
+require 'ecoportal/api/common/response'
+require 'ecoportal/api/common/wrapped_response'
+require 'ecoportal/api/common/base_model'
+require 'ecoportal/api/common/batch_operation'
+require 'ecoportal/api/common/batch_response'
+require 'ecoportal/api/common/hash_diff'

data/lib/ecoportal/api/common/base_model.rb

@@ -0,0 +1,39 @@
+module Ecoportal
+  module API
+    module Common
+      class BaseModel
+        attr_reader :doc
+        def initialize(doc = {})
+          @doc          = doc
+          @original_doc = JSON.parse(doc.to_json)
+        end
+
+        def print
+          puts JSON.pretty_generate(as_json)
+          self
+        end
+
+        def as_json
+          doc
+        end
+
+        def as_update
+          new_doc = as_json
+          Common::HashDiff.diff(new_doc, @original_doc)
+        end
+
+        def self.passthrough(*methods, to:)
+          methods.each do |method|
+            method = method.to_s
+            define_method method do
+              send(to)[method]
+            end
+            define_method "#{method}=" do |value|
+              send(to)[method] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/batch_operation.rb

@@ -0,0 +1,94 @@
+require 'ecoportal/api/common/doc_helpers'
+module Ecoportal
+  module API
+    module Common
+      class BatchOperation
+        include Common::DocHelpers
+
+        def initialize(base_path, wrapper)
+          @base_path  = base_path
+          @wrapper    = wrapper
+          @operations = []
+        end
+
+        def as_json
+          {
+            actions: @operations.map do |operation|
+              operation.slice(:path, :method, :body)
+            end
+          }
+        end
+
+        def process_response(response)
+          if response.success?
+            response.body.each.with_index do |subresponse, idx|
+              next unless callback = @operations[idx][:callback]
+
+              status = subresponse["status"]
+              body   = subresponse["response"]
+              method = @operations[idx][:method]
+
+              batch_response = BatchResponse.new(status, body)
+              if batch_response.success? && method == "GET"
+                callback.call response, @wrapper.new(body)
+              else
+                callback.call batch_response
+              end
+            end
+          else
+            raise "Total failure in batch operation"
+          end
+        end
+
+        def get(id)
+          @operations << {
+            path:     @base_path + "/" + CGI::escape(id),
+            method:   "GET",
+            callback: block_given? && Proc.new
+          }
+        end
+
+        def update(doc)
+          id   = get_id(doc)
+          body = get_body(doc)
+          @operations << {
+            path:     @base_path + "/" + CGI::escape(id),
+            method:   "PATCH",
+            body:     body,
+            callback: block_given? && Proc.new
+          }
+        end
+
+        def upsert(doc)
+          id   = get_id(doc)
+          body = get_body(doc)
+          @operations << {
+            path:     @base_path + "/" + CGI::escape(id),
+            method:   "POST",
+            body:     body,
+            callback: block_given? && Proc.new
+          }
+        end
+
+        def delete(doc)
+          id = get_id(doc)
+          @operations << {
+            path:     @base_path + "/" + CGI::escape(id),
+            method:   "DELETE",
+            callback: block_given? && Proc.new
+          }
+        end
+
+        def create(doc)
+          body = get_body(doc)
+          @operations << {
+            path:     @base_path,
+            method:   "POST",
+            body:     body,
+            callback: block_given? && Proc.new
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/batch_response.rb

@@ -0,0 +1,16 @@
+module Ecoportal
+  module API
+    module Common
+      class BatchResponse
+        attr_reader :status, :body
+        def initialize(status, body)
+          @status = status
+          @body   = body
+        end
+        def success?
+          (0..299).include?(status)
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/client.rb

@@ -0,0 +1,58 @@
+require 'http'
+module Ecoportal
+  module API
+    module Common
+      class Client
+        def initialize(api_key:, version: "v1", host: "live.ecoportal.com")
+          @version  = version
+          @api_key  = api_key
+          if host.match(/^localhost|^127\.0\.0\.1/)
+            @base_uri = "http://#{host}/api/"
+          else
+            @base_uri = "https://#{host}/api/"
+          end
+        end
+
+        def get(path, params: {})
+          request do |http|
+            http.get(url_for(path), params: params)
+          end
+        end
+
+        def post(path, data:)
+          request do |http|
+            http.post(url_for(path), json: data)
+          end
+        end
+
+        def patch(path, data:)
+          request do |http|
+            http.patch(url_for(path), json: data)
+          end
+        end
+
+        def delete(path)
+          request do |http|
+            http.delete(url_for(path))
+          end
+        end
+
+        def request
+          wrap_response yield(base_request)
+        end
+
+        def wrap_response(response)
+          Ecoportal::API::Common::Response.new(response)
+        end
+
+        def base_request
+          @base_request ||= HTTP.headers("X-ApiKey" => @api_key).accept(:json)
+        end
+
+        def url_for(path)
+          @base_uri+@version+path
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/doc_helpers.rb

@@ -0,0 +1,27 @@
+module Ecoportal
+  module API
+    module Common
+      module DocHelpers
+        def get_body(doc)
+          if doc.respond_to?(:as_update)
+            doc.as_update
+          elsif doc.respond_to?(:as_json)
+            doc.as_json
+          else
+            doc
+          end
+        end
+        def get_id(doc)
+          id = nil
+          id ||= doc.id if doc.respond_to?(:id)
+          id ||= doc.external_id if doc.respond_to?(:external_id)
+          id ||= doc["id"] if doc.is_a?(Hash)
+          id ||= doc["external_id"] if doc.is_a?(Hash)
+          id ||= doc if doc.is_a?(String)
+          id or raise "No ID has been given!"
+          id
+        end
+      end
+    end
+  end
+end