ecoportal-api 0.3.8 → 0.4.1

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

@@ -1,28 +1,45 @@
 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
 
-        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

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V1
       class SchemaField < Common::BaseModel
-        passthrough :id, :alt_id, :name, :optional, :shared, :multiple, :type, :options, to: :doc
+        passthrough :id, :alt_id, :name, :optional, :shared, :multiple, :type, :options
 
         def parse_text(value)
           values = [*value.to_s.lines].map do |line|

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

@@ -1,8 +1,9 @@
 module Ecoportal
   module API
     class V1
+      # @todo Rename to PersonDetailsField
       class SchemaFieldValue < Common::BaseModel
-        passthrough :id, :alt_id, :type, :name, :shared, :multiple, to: :doc
+        passthrough :id, :alt_id, :type, :name, :shared, :multiple
 
         def value
           return @value if defined?(@value)

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.3.8"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.1
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2019-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +130,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -100,6 +141,7 @@ files:
 - ecoportal-api.gemspec
 - lib/ecoportal/api.rb
 - lib/ecoportal/api/common.rb
+- lib/ecoportal/api/common/base_class.rb
 - lib/ecoportal/api/common/base_model.rb
 - lib/ecoportal/api/common/batch_operation.rb
 - lib/ecoportal/api/common/batch_response.rb
@@ -155,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's various APIs