ecoportal-api 0.1.0

data/lib/ecoportal/api/v1/person.rb

@@ -0,0 +1,50 @@
+module Ecoportal
+  module API
+    class V1
+      class Person < Common::BaseModel
+        passthrough :id, :external_id, :name, :email, :supervisor_id, to: :doc
+
+        def supervisor(client)
+          return @supervisor if defined?(@supervisor)
+          return @supervisor = nil if supervisor_id.nil?
+          @supervisor = client.people.get(supervisor_id).result
+        end
+
+        def supervisor=(person)
+          self.supervisor_id = person.id
+        end
+
+        def as_json
+          super.merge "details" => details&.as_json
+        end
+
+        def details
+          return @details if defined?(@details)
+          return @details = nil if doc["details"].nil?
+          @details = person_details_class.new(doc["details"])
+        end
+
+        def details=(value)
+          case value
+          when NilClass
+            doc["details"] = nil
+          when V1::PersonDetails
+            doc["details"] = JSON.parse(value.to_json)
+          when Hash
+            doc["details"] = value.slice("schema_id", "fields")
+          else
+            raise "Invalid set on details: Need nil, PersonDetails or Hash; got #{value.class}"
+          end
+          remove_instance_variable("@details")
+          return details
+        end
+
+        private
+
+        def person_details_class
+          V1::PersonDetails
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v1/person_details.rb

@@ -0,0 +1,51 @@
+module Ecoportal
+  module API
+    class V1
+      class PersonDetails < Common::BaseModel
+        passthrough :schema_id, to: :doc
+
+        def as_json
+          super.merge "fields" => fields.map(&:as_json)
+        end
+
+        def schema_id=(value)
+          @fields = [] if value.nil?
+          super
+        end
+
+        def fields
+          return @fields if defined?(@fields)
+          @fields = (doc["fields"] || []).map do |field|
+            schema_field_value_class.new(field)
+          end
+        end
+
+        def index_fields
+          @fields_by_id     = {}
+          @fields_by_alt_id = {}
+          fields.each do |wrapped|
+            @fields_by_id[wrapped.id] = wrapped
+            @fields_by_id[wrapped.alt_id] = wrapped
+          end
+        end
+
+        def [](id)
+          @fields_by_id or index_fields
+          (@fields_by_id[id] || @fields_by_alt_id[id])&.value
+        end
+        def []=(id, value)
+          @fields_by_id or index_fields
+          if field = (@fields_by_id[id] || @fields_by_alt_id[id])
+            field.value = value
+          end
+        end
+
+        private
+
+        def schema_field_value_class
+          V1::SchemaFieldValue
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v1/person_schema.rb

@@ -0,0 +1,46 @@
+module Ecoportal
+  module API
+    class V1
+      class PersonSchema < Common::BaseModel
+        passthrough :id, :name, to: :doc
+
+        def fields
+          @fields_by_id or index_fields
+          @fields_by_id.values
+        end
+
+        def fields_by_id
+          @fields_by_id or index_fields
+          @fields_by_id
+        end
+
+        def fields_by_alt_id
+          @fields_by_alt_id or index_fields
+          @fields_by_alt_id
+        end
+
+        def [](id)
+          @fields_by_alt_id or index_fields
+          @fields_by_id[id] || @fields_by_alt_id[id]
+        end
+
+        def index_fields
+          @fields_by_id     = {}
+          @fields_by_alt_id = {}
+          doc["fields"].each do |field|
+            wrapped = schema_field_class.new(field)
+            @fields_by_id[wrapped.id] = wrapped
+            @fields_by_id[wrapped.alt_id] = wrapped
+          end
+        end
+
+        private
+
+        def schema_field_class
+          V1::SchemaField
+        end
+      end
+    end
+  end
+end
+require 'ecoportal/api/v1/schema_field'

data/lib/ecoportal/api/v1/person_schemas.rb

@@ -0,0 +1,24 @@
+module Ecoportal
+  module API
+    class V1
+      class PersonSchemas
+        attr_reader :client
+        def initialize(client)
+          @client = client
+        end
+        def get_all
+          response = @client.get("/person_schemas")
+          Common::WrappedResponse.new(response, person_schema_class)
+        end
+
+        private
+
+        def person_schema_class
+          V1::PersonSchema
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v1/person_schema'

data/lib/ecoportal/api/v1/schema_field.rb

@@ -0,0 +1,9 @@
+module Ecoportal
+  module API
+    class V1
+      class SchemaField < Common::BaseModel
+        passthrough :id, :alt_id, :name, :optional, :shared, :multiple, :type, :options, to: :doc
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v1/schema_field_value.rb

@@ -0,0 +1,67 @@
+module Ecoportal
+  module API
+    class V1
+      class SchemaFieldValue < Common::BaseModel
+        passthrough :id, :alt_id, :type, :name, :shared, :multiple, to: :doc
+
+        def value
+          return @value if defined?(@value)
+          @value = case type
+                   when "text", "phone_number", "number", "boolean", "select"
+                     doc["value"]
+                   when "date"
+                     if doc["value"]
+                       maybe_multiple(doc["value"]) do |v|
+                         DateTime.iso8601(v)
+                       end
+                     end
+                   else
+                     raise "Unknown type #{type}"
+                   end
+        end
+
+        def value=(value)
+          case type
+          when "text", "phone_number", "select"
+            doc["value"] = @value = maybe_multiple(value) do |v|
+              v&.to_s
+            end
+          when "number"
+            maybe_multiple(value) do |v|
+              unless v.nil? || v.is_a?(Numeric)
+                raise "Invalid number type #{v.class}"
+              end
+            end
+            doc["value"] = @value = value
+          when "boolean"
+            doc["value"] = @value = !!value
+          when "date"
+            maybe_multiple(value) do |v|
+              unless v.nil? || v.respond_to?(:iso8601)
+                raise "Invalid date type #{v.class}"
+              end
+            end
+            @value       = value
+            doc["value"] = maybe_multiple(@value) do |v|
+              v&.iso8601
+            end
+          else
+            raise "Unknown type #{type}"
+          end
+          @value
+        end
+
+        def maybe_multiple(value)
+          if multiple
+            unless value.is_a?(Array)
+              raise "Expected Array, got #{value.class}"
+            end
+            value.map {|v| yield v }
+          else
+            yield value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/version.rb

@@ -0,0 +1,5 @@
+module Ecoportal
+  module API
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: ecoportal-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tapio Saarinen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-28 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: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- tapio@ecoportal.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ecoportal-api.gemspec
+- lib/ecoportal/api.rb
+- lib/ecoportal/api/common.rb
+- lib/ecoportal/api/common/base_model.rb
+- lib/ecoportal/api/common/batch_operation.rb
+- lib/ecoportal/api/common/batch_response.rb
+- lib/ecoportal/api/common/client.rb
+- lib/ecoportal/api/common/doc_helpers.rb
+- lib/ecoportal/api/common/hash_diff.rb
+- lib/ecoportal/api/common/response.rb
+- lib/ecoportal/api/common/wrapped_response.rb
+- lib/ecoportal/api/internal.rb
+- lib/ecoportal/api/internal/.git-keep
+- lib/ecoportal/api/internal/account.rb
+- lib/ecoportal/api/internal/login_provider.rb
+- lib/ecoportal/api/internal/login_providers.rb
+- lib/ecoportal/api/internal/people.rb
+- lib/ecoportal/api/internal/permissions.rb
+- lib/ecoportal/api/internal/person.rb
+- lib/ecoportal/api/internal/person_details.rb
+- lib/ecoportal/api/internal/person_schema.rb
+- lib/ecoportal/api/internal/person_schemas.rb
+- lib/ecoportal/api/internal/policy_group.rb
+- lib/ecoportal/api/internal/policy_groups.rb
+- lib/ecoportal/api/internal/preferences.rb
+- lib/ecoportal/api/internal/schema_field.rb
+- lib/ecoportal/api/internal/schema_field_value.rb
+- lib/ecoportal/api/v1.rb
+- lib/ecoportal/api/v1/.git-keep
+- lib/ecoportal/api/v1/people.rb
+- lib/ecoportal/api/v1/person.rb
+- lib/ecoportal/api/v1/person_details.rb
+- lib/ecoportal/api/v1/person_schema.rb
+- lib/ecoportal/api/v1/person_schemas.rb
+- lib/ecoportal/api/v1/schema_field.rb
+- lib/ecoportal/api/v1/schema_field_value.rb
+- lib/ecoportal/api/version.rb
+homepage: https://www.ecoportal.com
+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.6
+signing_key: 
+specification_version: 4
+summary: A collection of helpers for interacting with the ecoPortal MS's various APIs
+test_files: []