ecoportal-api 0.1.0

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

@@ -0,0 +1,37 @@
+module Ecoportal
+  module API
+    module Common
+      module HashDiff
+        ID_KEYS=%w[id]
+        def self.diff(a, b)
+          return a if a.class != b.class
+          case a
+          when Hash
+            {}.tap do |diffed|
+              a.each do |key, a_value|
+                b_value = b[key]
+                next if a_value == b_value && !ID_KEYS.include?(key)
+                diffed[key] = diff(a_value, b_value)
+                diffed.delete[key] if diffed[key] == {}
+              end
+              # All keys are IDs, so it's actually blank
+              if (diffed.keys - ID_KEYS).empty?
+                return {}
+              end
+            end
+          when Array
+            return a unless a.length == b.length
+            a.map.with_index do |a_value, idx|
+              b_value = b[idx]
+              diff(a_value, b_value)
+            end.reject do |el|
+              el == {}
+            end
+          else
+            a
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Ecoportal
+  module API
+    module Common
+      class Response
+        attr_reader :status, :body
+        def initialize(response)
+          @status = response.status
+          @body   = JSON.parse(response.to_s) rescue nil
+          response.flush
+        end
+        def success?
+          @status.success?
+        end
+        def print
+          puts "Status: #{@status.code}"
+          puts "Body:"
+          puts JSON.pretty_generate(@body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Ecoportal
+  module API
+    module Common
+      class WrappedResponse
+        attr_reader :response, :result
+        def initialize(response, klass)
+          @response = response
+          @klass    = klass
+
+          if @response.success?
+            @result = if @response.body.is_a?(Array)
+                        @response.body.map do |doc|
+                          @klass.new(doc)
+                        end
+                      else
+                        @klass.new(@response.body)
+                      end
+          end
+        end
+        def each
+          [*@result].each do |doc|
+            yield doc
+          end
+        end
+        def success?
+          @response.success?
+        end
+        def print
+          if success?
+            @result&.map(&:print)
+          else
+            puts "Request failed."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/internal.rb

@@ -0,0 +1,31 @@
+module Ecoportal
+  module API
+    class Internal
+      attr_reader :client
+      def initialize(api_key, host: "live.ecoportal.com")
+        @client = Common::Client.new(
+          api_key: api_key,
+          host:    host,
+          version: "v0"
+        )
+      end
+      def people
+        Internal::People.new(client)
+      end
+      def person_schemas
+        Internal::PersonSchemas.new(client)
+      end
+      def policy_groups
+        Internal::PolicyGroups.new(client)
+      end
+      def login_providers
+        Internal::LoginProviders.new(client)
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/internal/people'
+require 'ecoportal/api/internal/person_schemas'
+require 'ecoportal/api/internal/policy_groups'
+require 'ecoportal/api/internal/login_providers'

data/lib/ecoportal/api/internal/account.rb

@@ -0,0 +1,31 @@
+module Ecoportal
+  module API
+    class Internal
+      class Account < Common::BaseModel
+        passthrough :policy_group_ids, :landing_page_id, :permissions_preset, :permissions_custom, :preferences, :prefilter, :filter_tags, :login_provider_ids, :starred_ids, to: :doc
+
+        def preset=(value)
+          self.permissions_preset = value == "custom" ? nil : value
+        end
+
+        def preset
+          self.permissions_preset.nil? ? "custom" : self.permissions_preset
+        end
+
+        def permissions
+          return @permissions if defined?(@permissions)
+          return @permissions = nil if doc["permissions_custom"].nil?
+          @permissions = Internal::Permissions.new(doc["permissions_custom"])
+        end
+
+        def preferences
+          return @preferences if defined?(@preferences)
+          return @preferences = nil if doc["preferences"].nil?
+          @preferences = Internal::Preferences.new(doc["preferences"])
+        end
+      end
+    end
+  end
+end
+require 'ecoportal/api/internal/permissions'
+require 'ecoportal/api/internal/preferences'

data/lib/ecoportal/api/internal/login_provider.rb

@@ -0,0 +1,9 @@
+module Ecoportal
+  module API
+    class Internal
+      class LoginProvider < Common::BaseModel
+        passthrough :id, :name, :type, :enabled_for, to: :doc
+      end
+    end
+  end
+end

data/lib/ecoportal/api/internal/login_providers.rb

@@ -0,0 +1,18 @@
+module Ecoportal
+  module API
+    class Internal
+      class LoginProviders
+        attr_reader :client
+        def initialize(client)
+          @client = client
+        end
+        def get_all
+          response = @client.get("/login_providers")
+          Common::WrappedResponse.new(response, Internal::LoginProvider)
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/internal/login_provider'

data/lib/ecoportal/api/internal/people.rb

@@ -0,0 +1,19 @@
+require 'ecoportal/api/common/doc_helpers'
+module Ecoportal
+  module API
+    class Internal
+      class People < V1::People
+        private
+
+        def person_class
+          Internal::Person
+        end
+      end        
+    end
+  end
+end
+
+require 'ecoportal/api/internal/person'
+require 'ecoportal/api/internal/person_details'
+require 'ecoportal/api/internal/schema_field_value'
+require 'ecoportal/api/internal/account'

data/lib/ecoportal/api/internal/permissions.rb

@@ -0,0 +1,9 @@
+module Ecoportal
+  module API
+    class Internal
+      class Permissions < Common::BaseModel
+        passthrough :files, :data, :reports, :organization, :people, :pages, :page_editor, :registers, to: :doc
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Ecoportal
+  module API
+    class Internal
+      class Person < V1::Person
+        def as_json
+          super.update("account" => account&.as_json)
+        end
+
+        def account
+          return @account if defined?(@account)
+          return @account = nil if doc["account"].nil?
+          @account = Internal::Account.new(doc["account"])
+        end
+
+        def account=(value)
+          case value
+          when NilClass
+            doc["account"] = nil
+          when Internal::Account
+            doc["account"] = JSON.parse(value.to_json)
+          when Hash
+            # TODO
+            doc["account"] = value.slice(%w[policy_group_ids landing_page_id permissions_preset permissions_custom preferences prefilter filter_tags login_provider_ids starred_ids])
+          else
+            # TODO
+            raise "Invalid set on account: Need nil, Account or Hash; got #{value.class}"
+          end
+          remove_instance_variable("@account")
+          return account
+        end
+
+        private
+
+        def person_details_class
+          Internal::PersonDetails
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class Internal
+      class PersonDetails < V1::PersonDetails
+        private
+
+        def schema_field_value_class
+          Internal::SchemaFieldValue
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class Internal
+      class PersonSchema < V1::PersonSchema
+        private
+
+        def schema_field_class
+          Internal::SchemaField
+        end
+      end
+    end
+  end
+end
+require 'ecoportal/api/internal/schema_field'

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

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class Internal
+      class PersonSchemas < V1::PersonSchemas
+        private
+
+        def person_schema_class
+          Internal::PersonSchema
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/internal/person_schema'

data/lib/ecoportal/api/internal/policy_group.rb

@@ -0,0 +1,9 @@
+module Ecoportal
+  module API
+    class Internal
+      class PolicyGroup < Common::BaseModel
+        passthrough :id, :name, to: :doc
+      end
+    end
+  end
+end

data/lib/ecoportal/api/internal/policy_groups.rb

@@ -0,0 +1,18 @@
+module Ecoportal
+  module API
+    class Internal
+      class PolicyGroups
+        attr_reader :client
+        def initialize(client)
+          @client = client
+        end
+        def get_all
+          response = @client.get("/policy_groups")
+          Common::WrappedResponse.new(response, Internal::PolicyGroup)
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/internal/policy_group'

data/lib/ecoportal/api/internal/preferences.rb

@@ -0,0 +1,9 @@
+module Ecoportal
+  module API
+    class Internal
+      class Preferences < Common::BaseModel
+        passthrough :show_sidebar, :show_shortcuts, :show_coming_soon, :show_recently_visited_forms, :show_tasks, to: :doc
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Ecoportal
+  module API
+    class Internal
+      class SchemaField < V1::SchemaField
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Ecoportal
+  module API
+    class Internal
+      class SchemaFieldValue < V1::SchemaFieldValue
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v1.rb

@@ -0,0 +1,23 @@
+module Ecoportal
+  module API
+    class V1
+      attr_reader :client
+      def initialize(api_key, host: "live.ecoportal.com")
+        @client = Common::Client.new(
+          api_key: api_key,
+          host:    host,
+          version: "v1"
+        )
+      end
+      def people
+        V1::People.new(client)
+      end
+      def person_schemas
+        V1::PersonSchemas.new(client)
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v1/people'
+require 'ecoportal/api/v1/person_schemas'

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

@@ -0,0 +1,98 @@
+require 'ecoportal/api/common/doc_helpers'
+module Ecoportal
+  module API
+    class V1
+      class People
+        include Common::DocHelpers
+        attr_reader :client
+
+        def initialize(client)
+          @client = client
+        end
+
+        def each(params: {}, &block)
+          page = 1
+          loop do
+            response = @client.get("/people", params: params.merge(page: page))
+            raise "Request failed." unless response.success?
+            response.body["results"].each do |person|
+              yield person_class.new(person)
+            end
+            break if page >= response.body["total_pages"]
+            page += 1
+          end
+          self
+        end
+
+        def get(id)
+          response = @client.get("/people/"+CGI::escape(id))
+          Common::WrappedResponse.new(response, person_class)
+        end
+
+        def get_all(params: {})
+          each(params).to_a
+        end
+
+        def update(doc)
+          body = get_body(doc)
+          id   = get_id(doc)
+          @client.patch("/people/"+CGI::escape(id), data: body)
+        end
+
+        def create(doc)
+          body = get_body(doc)
+          @client.post("/people", data: body)
+        end
+
+        def upsert(doc)
+          body = get_body(doc)
+          id   = get_id(doc)
+          @client.post("/people/"+CGI::escape(id), data: body)
+        end
+
+        def batch
+          operation = Common::BatchOperation.new("/people", person_class)
+          yield operation
+          @client.post("/people/batch", data: operation.as_json).tap do |response|
+            operation.process_response(response)
+          end
+        end
+
+        def delete(doc)
+          id = get_id(doc)
+          @client.delete("/people/"+CGI::escape(id))
+        end
+
+        private
+
+        def person_class
+          V1::Person
+        end
+
+        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
+
+require 'ecoportal/api/v1/person'
+require 'ecoportal/api/v1/person_details'
+require 'ecoportal/api/v1/schema_field_value'