ecoportal-api 0.8.5 → 0.9.2

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

@@ -1,48 +1,48 @@
-module Ecoportal
-  module API
-    class V1
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-      class PersonSchemas
-        extend Common::BaseClass
-        include Enumerable
-
-        class_resolver :person_schema_class,  "Ecoportal::API::V1::PersonSchema"
-
-        attr_reader :client
-
-        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-        # @return [Schemas] an instance object ready to make schema api requests.
-        def initialize(client)
-          @client = client
-        end
-
-        # Gets all the schemas via api request.
-        # @return [Enumerable<PersonSchema>] an `Enumerable` with all schemas already wrapped as `PersonSchema` objects.
-        def get_all
-          response = client.get("/person_schemas")
-          Common::WrappedResponse.new(response, person_schema_class)
-        end
-
-        # If a `block` is **not** given it calls [Object#to_enum](https://ruby-doc.org/core-2.6.2/Object.html#method-i-to_enum)
-        # Otherwise it calls `get_all`.
-        # @note
-        #   - `:params` doesn't really do anything.
-        #   - same as #get_all but with block :)
-        #   - `to_a` will call `each` (see this [detailed explanation](https://stackoverflow.com/a/45201663/4352306))
-        #     - however, as far as you have an iterator, such as `each`, `to_a` should be last resource (see [this explanation](https://stackoverflow.com/a/44186921/4352306))
-        # @yield [schema] does some stuff with the schema.
-        # @yieldparam schema [PersonSchema]
-        # @yieldreturn [PersonSchema]
-        # @return [Enumerable<PersonSchema>] an `Enumerable` with all the person schema objects.
-        def each(params: {}, &block)
-          return to_enum(:each) unless block
-          get_all.each(&block)
-        end
-
-
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/v1/person_schema'
+module Ecoportal
+  module API
+    class V1
+      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      class PersonSchemas
+        extend Common::BaseClass
+        include Enumerable
+
+        class_resolver :person_schema_class,  "Ecoportal::API::V1::PersonSchema"
+
+        attr_reader :client
+
+        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @return [Schemas] an instance object ready to make schema api requests.
+        def initialize(client)
+          @client = client
+        end
+
+        # Gets all the schemas via api request.
+        # @return [Enumerable<PersonSchema>] an `Enumerable` with all schemas already wrapped as `PersonSchema` objects.
+        def get_all
+          response = client.get("/person_schemas")
+          Common::WrappedResponse.new(response, person_schema_class)
+        end
+
+        # If a `block` is **not** given it calls [Object#to_enum](https://ruby-doc.org/core-2.6.2/Object.html#method-i-to_enum)
+        # Otherwise it calls `get_all`.
+        # @note
+        #   - `:params` doesn't really do anything.
+        #   - same as #get_all but with block :)
+        #   - `to_a` will call `each` (see this [detailed explanation](https://stackoverflow.com/a/45201663/4352306))
+        #     - however, as far as you have an iterator, such as `each`, `to_a` should be last resource (see [this explanation](https://stackoverflow.com/a/44186921/4352306))
+        # @yield [schema] does some stuff with the schema.
+        # @yieldparam schema [PersonSchema]
+        # @yieldreturn [PersonSchema]
+        # @return [Enumerable<PersonSchema>] an `Enumerable` with all the person schema objects.
+        def each(params: {}, &block)
+          return to_enum(:each) unless block
+          get_all.each(&block)
+        end
+
+
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v1/person_schema'

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

@@ -1,34 +1,34 @@
-module Ecoportal
-  module API
-    class V1
-      class SchemaField < Common::BaseModel
-        passthrough :id, :alt_id, :name, :optional, :shared, :multiple, :type, :options
-
-        def parse_text(value)
-          values = [*value.to_s.lines].map do |line|
-            line = line.chomp
-            next if line == ""
-            case type
-            when "text", "phone_number"
-              line
-            when "number"
-              Float(line) rescue return nil, false
-            when "boolean"
-              %w[true TRUE True Y y YES X x].include?(line)
-            when "select"
-              return nil, false unless options.include?(line)
-              line
-            when "date"
-              Date.parse(line) rescue return nil, false
-            end
-          end.compact
-          if multiple
-            return values, true
-          else
-            return values.first, true
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class V1
+      class SchemaField < Common::BaseModel
+        passthrough :id, :alt_id, :name, :optional, :shared, :multiple, :type, :options
+
+        def parse_text(value)
+          values = [*value.to_s.lines].map do |line|
+            line = line.chomp
+            next if line == ""
+            case type
+            when "text", "phone_number"
+              line
+            when "number"
+              Float(line) rescue return nil, false
+            when "boolean"
+              %w[true TRUE True Y y YES X x].include?(line)
+            when "select"
+              return nil, false unless options.include?(line)
+              line
+            when "date"
+              Date.parse(line) rescue return nil, false
+            end
+          end.compact
+          if multiple
+            return values, true
+          else
+            return values.first, true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,65 +1,65 @@
-module Ecoportal
-  module API
-    class V1
-      # @todo Rename to PersonDetailsField
-      class SchemaFieldValue < Common::BaseModel
-        passthrough :id, :alt_id, :type, :name, :shared, :multiple
-
-        def value
-          case type
-          when "text", "phone_number", "number", "boolean", "select"
-           doc["value"]
-          when "date"
-           if doc["value"]
-             maybe_multiple(doc["value"]) do |v|
-               Date.iso8601(v)
-             end
-           end
-          else
-           raise "Unknown type #{type}"
-          end
-        end
-
-        def value=(value)
-          case type
-          when "text", "phone_number", "select"
-            doc["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
-          when "boolean"
-            doc["value"] = !!value
-          when "date"
-            maybe_multiple(value) do |v|
-              unless v.nil? || v.respond_to?(:to_date)
-                raise "Invalid date type #{v.class}"
-              end
-            end
-            doc["value"] = maybe_multiple(value) do |v|
-              v&.to_date&.to_s
-            end
-          else
-            raise "Unknown type #{type}"
-          end
-        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
+module Ecoportal
+  module API
+    class V1
+      # @todo Rename to PersonDetailsField
+      class SchemaFieldValue < Common::BaseModel
+        passthrough :id, :alt_id, :type, :name, :shared, :multiple
+
+        def value
+          case type
+          when "text", "phone_number", "number", "boolean", "select"
+           doc["value"]
+          when "date"
+           if doc["value"]
+             maybe_multiple(doc["value"]) do |v|
+               Date.iso8601(v)
+             end
+           end
+          else
+           raise "Unknown type #{type}"
+          end
+        end
+
+        def value=(value)
+          case type
+          when "text", "phone_number", "select"
+            doc["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
+          when "boolean"
+            doc["value"] = !!value
+          when "date"
+            maybe_multiple(value) do |v|
+              unless v.nil? || v.respond_to?(:to_date)
+                raise "Invalid date type #{v.class}"
+              end
+            end
+            doc["value"] = maybe_multiple(value) do |v|
+              v&.to_date&.to_s
+            end
+          else
+            raise "Unknown type #{type}"
+          end
+        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/v1.rb

@@ -1,49 +1,49 @@
-module Ecoportal
-  module API
-    # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-    # @attr_reader logger [Logger] the logger.
-    class V1
-      extend Common::BaseClass
-      include Common::Logging
-
-      VERSION = "v1"
-      class_resolver :people_class,  "Ecoportal::API::V1::People"
-      class_resolver :person_schemas_class,  "Ecoportal::API::V1::PersonSchemas"
-
-      attr_reader :client, :logger
-
-      # Creates an `V1` object to scope version specific api requests.
-      # @note
-      #   - The const `VERSION` determineds the api version that client will query against.
-      #   - This means that each sublcass of `V1` should define their own `VERSION` constant.
-      # @param api_key [String] the key version to stablish the api connection.
-      # @param host [String] api server domain.
-      # @param logger [Logger] an object with `Logger` interface to generate logs.
-      # @return [V1] an object with the api version suit.
-      def initialize(api_key, host: "live.ecoportal.com", logger: default_logger)
-        @logger = logger
-        @client = Common::Client.new(
-          api_key: api_key,
-          host:    host,
-          version: self.class::VERSION,
-          logger:  @logger
-        )
-      end
-
-      # Obtain specific object for people api requests.
-      # @return [People] an instance object ready to make people api requests.
-      def people
-        people_class.new(client)
-      end
-
-      # Obtain specific object for schema api requests.
-      # @return [PersonSchemas] an instance object ready to make schema api requests.
-      def person_schemas
-        person_schemas_class.new(client)
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/v1/person_schemas'
-require 'ecoportal/api/v1/people'
+module Ecoportal
+  module API
+    # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+    # @attr_reader logger [Logger] the logger.
+    class V1
+      extend Common::BaseClass
+      include Common::Logging
+
+      VERSION = "v1"
+      class_resolver :people_class,  "Ecoportal::API::V1::People"
+      class_resolver :person_schemas_class,  "Ecoportal::API::V1::PersonSchemas"
+
+      attr_reader :client, :logger
+
+      # Creates an `V1` object to scope version specific api requests.
+      # @note
+      #   - The const `VERSION` determineds the api version that client will query against.
+      #   - This means that each sublcass of `V1` should define their own `VERSION` constant.
+      # @param api_key [String] the key version to stablish the api connection.
+      # @param host [String] api server domain.
+      # @param logger [Logger] an object with `Logger` interface to generate logs.
+      # @return [V1] an object with the api version suit.
+      def initialize(api_key, host: "live.ecoportal.com", logger: default_logger)
+        @logger = logger
+        @client = Common::Client.new(
+          api_key: api_key,
+          host:    host,
+          version: self.class::VERSION,
+          logger:  @logger
+        )
+      end
+
+      # Obtain specific object for people api requests.
+      # @return [People] an instance object ready to make people api requests.
+      def people
+        people_class.new(client)
+      end
+
+      # Obtain specific object for schema api requests.
+      # @return [PersonSchemas] an instance object ready to make schema api requests.
+      def person_schemas
+        person_schemas_class.new(client)
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v1/person_schemas'
+require 'ecoportal/api/v1/people'

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
-module Ecoportal
-  module API
-    VERSION = "0.8.5"
-  end
-end
+module Ecoportal
+  module API
+    VERSION = "0.9.2"
+  end
+end

data/lib/ecoportal/api.rb

@@ -1,16 +1,16 @@
-require "cgi"
-require "logger"
-require "hash-polyfill"
-require "ecoportal/api/version"
-require "dotenv/load"
-
-module Ecoportal
-  module API
-  end
-end
-
-require "ecoportal/api/logger"
-require "ecoportal/api/common"
-require "ecoportal/api/errors"
-require "ecoportal/api/v1"
-require "ecoportal/api/internal"
+require "cgi"
+require "logger"
+require "hash-polyfill"
+require "ecoportal/api/version"
+require "dotenv/load"
+
+module Ecoportal
+  module API
+  end
+end
+
+require "ecoportal/api/logger"
+require "ecoportal/api/common"
+require "ecoportal/api/errors"
+require "ecoportal/api/v1"
+require "ecoportal/api/internal"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.2
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -281,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's various APIs