plate_api 1.2.4 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 947c12da1663740de9378f1c065f158630eef3a7cccc901b728f523db3777194
-  data.tar.gz: 9c5e26eb8a8e70a7eca3b9511e38e649be72933a52975bcc793d6d79e4268d93
+  metadata.gz: 600f799a54373ccf8b006bddb1d97e268d2ec9a427551fce6022bf1faed41e67
+  data.tar.gz: 775cbeedcfe25f9c77705388403be50a030b6c1350c46195026ad00e148a234f
 SHA512:
-  metadata.gz: 7f0e809ce4944a826e2c4ddf3e085e87ceb96e76a7cf96fa9261e24e27da78d3773abea76c93a8e24ee89fb6a9ba28bd8efa9249d5289248a3fd5df2f6796280
-  data.tar.gz: 736048b6087f9c42f0d246d0dc6f5b39d9c09f3dc08957056a47ca2f4c4079c11574691387dace9428fb692c829d7df3c30c41a0880b6b314ba7dfec2896a681
+  metadata.gz: 4628865a07f17d67dc5bce69462f007a01143a46039bd133b30e9f16bccde2f925e4bd94416d5ab473d0a9fe8744f08a02b4b5ce37a82eeaa9c04f7516a6e88b
+  data.tar.gz: e6b6f0e6a65b2e4c3d7e1d56a38b1498a0631a58365ba3eef10cfde24fe77c98cbbec264c743a83dd0a1e2d290219096593b8ba47b0884c58a829d098ac1993a

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 coverage
 /secrets
+
+.byebug_history

data/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.7
+
+RUN mkdir /plate_api
+WORKDIR /plate_api
+COPY . /plate_api
+RUN bin/setup

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plate_api (1.2.4)
+    plate_api (1.2.8)
       faraday (~> 1.0.1)
       mime-types (~> 3.3.1)
 
@@ -32,7 +32,7 @@ GEM
       concurrent-ruby (~> 1.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
+    mime-types-data (3.2022.0105)
     minitest (5.14.1)
     multipart-post (2.1.1)
     public_suffix (4.0.5)

data/README.md

@@ -145,6 +145,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+## Run Specs with Docker
+```bash
+docker build -t plate_api_gem .
+docker run --rm -v $(pwd):/plate_api -it plate_api_gem rspec
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/plate_api/get_request.rb

@@ -3,14 +3,27 @@ module PlateApi
     def initialize(public_key, secret, path, parameters={}, custom_server=nil)
       super(public_key, secret, "GET", path, custom_server)
 
-      sorted_params = parameters.to_a.sort_by{|x| x[0]}
-      @url_parameters = sorted_params.map{|x| "#{x[0]}=#{x[1]}"}.join("&")
+      @url_parameters = build_url_parameters(parameters)
     end
 
     def url_path
       "#{@path}?#{@url_parameters}"
     end
 
+    # Translate a Hash of url parameters to a query string
+    def build_url_parameters(parameters)
+      sorted_params = parameters.to_a.sort_by{|x| x[0]}
+      query_string = sorted_params.map do |key, value|
+        if value.is_a? Array
+          value.map{|subvalue| "#{key}[]=#{subvalue}"}.join("&")
+        else
+          "#{key}=#{value}"
+        end
+      end.join("&")
+
+      query_string
+    end
+
     def url_parameters
       @url_parameters
     end

data/lib/plate_api/object_handler.rb

@@ -7,38 +7,42 @@ module PlateApi
     def initialize(handling_class, api_connector)
       raise ArgumentError, "`handling_class` given for #new is not valid" unless handling_class
       raise ArgumentError, "`api_connector` given for #new is not valid" unless api_connector
+
       @handling_class = handling_class
       @api_connector = api_connector
     end
 
     def find(id)
       raise ArgumentError, "`id` given for #find is not valid" unless id
+
       result = @api_connector.get(resource_path(id))
       if result["data"]
-        return new_object(result["data"])
+        new_object(result["data"])
       else
-        raise Error::Response, result
+        raise ResponseError, result
       end
     end
 
     def update(id, attributes)
       raise ArgumentError, "`id` given for #update is not valid" unless id
-      raise ArgumentError, "`attributes` given for #update is not valid" unless attributes.is_a? Hash
-      result = @api_connector.put(resource_path(id), {"data" => attributes})
+      raise ArgumentError, "`attributes` given for #update is not valid" unless attributes.is_a?(Hash)
+
+      result = @api_connector.put(resource_path(id), { "data" => attributes })
 
       if result["data"]
-        return new_object(result["data"])
+        new_object(result["data"])
       else
-        raise Error::Response, result
+        raise ResponseError, result
       end
     end
 
-    def create(parent, attributes, create_method=:post)
+    def create(parent, attributes, create_method = :post)
       raise ArgumentError, "`parent` given for #create is not valid" unless parent
-      raise ArgumentError, "`attributes` given for #create is not valid" unless attributes.is_a? Hash
+      raise ArgumentError, "`attributes` given for #create is not valid" unless attributes.is_a?(Hash)
+
       parameters = case create_method
       when :post
-        {"data" => attributes}
+        { "data" => attributes }
       when :post_multipart
         attributes
       end
@@ -46,45 +50,70 @@ module PlateApi
       result = @api_connector.send(create_method, collection_path(parent.class, parent.id), parameters)
 
       if result["data"]
-        return new_object(result["data"])
+        new_object(result["data"])
       else
-        raise Error::Response, result
+        raise ResponseError, result
       end
     end
 
     def delete(id)
       raise ArgumentError, "`id` given for #find is not valid" unless id
+
       result = @api_connector.delete(resource_path(id))
       if result["data"]
-        return new_object(result["data"])
+        new_object(result["data"])
       else
-        raise Error::Response, result
+        raise ResponseError, result
       end
     end
 
-    def index(parent_class, parent_id, extra_params={})
+    def index(parent_class, parent_id, extra_params = {}, return_raw = false)
       raise ArgumentError, "`parent_id` given for #index is not valid" unless parent_id
       raise ArgumentError, "`parent_class` given for #index is not valid" unless parent_class
 
       result = @api_connector.get(collection_path(parent_class, parent_id), extra_params)
-      if result["data"]
-        return result["data"].map{|x| new_object(x)}
-      else
-        raise Error::Response, result
+      raise ResponseError, result unless result["data"]
+      return result if return_raw
+
+      result["data"].map { |x| new_object(x) }
+    end
+
+    def index_block(parent_class, parent_id, extra_params = {}, &block)
+      extra_params[:page] = extra_params.delete("page") if extra_params["page"]
+      extra_params[:page] = 1 unless extra_params[:page]
+
+      pagination = index_block_iteration(parent_class, parent_id, extra_params, &block)
+      return unless pagination
+
+      while pagination["page"] < pagination["total_pages"]
+        extra_params.merge!(page: (pagination["page"] + 1))
+        pagination = index_block_iteration(parent_class, parent_id, extra_params, &block)
+        break unless pagination
       end
     end
 
     def index_total_count(parent)
       result = @api_connector.get(collection_path(parent.class, parent.id), per_page: 1)
       if result["meta"]
-        return result["meta"]["pagination"]["total_records"]
+        result["meta"]["pagination"]["total_records"]
       else
-        raise Error::Response, result
+        raise ResponseError, result
       end
     end
 
     private
 
+    def index_block_iteration(parent_class, parent_id, params)
+      result = index(parent_class, parent_id, params, true)
+      objects = result["data"].map { |x| new_object(x) }
+      meta = result["meta"]
+      yield(objects, meta)
+
+      # Returns pagination metadata so it can be used to
+      # iterate through the pages.
+      meta["pagination"] if meta
+    end
+
     # Construct a new object of @handling_class, given a succesful api_response
     def new_object(api_response)
       @handling_class.new(
@@ -99,15 +128,15 @@ module PlateApi
       "#{@handling_class.api_name}/#{id}"
     end
 
-    def collection_path(parent_class=nil, parent_id=nil)
-      if (parent_class != nil) ^ (parent_id != nil)
+    def collection_path(parent_class = nil, parent_id = nil)
+      if (!parent_class.nil?) ^ (!parent_id.nil?)
         raise ArgumentError, "An invalid combination `parent_class` and `parent_id` is given. Provide both or none."
       end
 
       if parent_class
         "#{parent_class.api_name}/#{parent_id}/#{@handling_class.api_name}"
       else
-        "#{@handling_class.api_name}"
+        @handling_class.api_name.to_s
       end
     end
   end

data/lib/plate_api/plate_object/base.rb

@@ -6,7 +6,7 @@ module PlateApi::PlateObject
     HasOneRelations = {}
     HasManyRelations = {}
 
-    def initialize(id, attributes, relations, object_handler=nil)
+    def initialize(id, attributes, relations, object_handler = nil)
       @id = id
       @object_handler = object_handler
       initialize_state(attributes, relations)
@@ -17,24 +17,27 @@ module PlateApi::PlateObject
     end
 
     def reload
-      raise ArgumentError.new("No object_handler is set.") unless @object_handler
+      raise ArgumentError, "No object_handler is set." unless @object_handler
+
       reinitialize(@object_handler.find(@id))
-      return self
+      self
     end
 
     def update(attributes)
-      raise ArgumentError.new("Input `attributes` is not a Hash") unless attributes.is_a? Hash
-      raise ArgumentError.new("No object_handler is attached to this object") unless @object_handler
+      raise ArgumentError, "Input `attributes` is not a Hash" unless attributes.is_a?(Hash)
+      raise ArgumentError, "No object_handler is attached to this object" unless @object_handler
+
       if new_object = @object_handler.update(@id, attributes)
         reinitialize(new_object)
       else
-        raise ArgumentError.new("The update was unsuccesful.")
+        raise ArgumentError, "The update was unsuccesful."
       end
-      return self
+      self
     end
 
     def delete
-      raise ArgumentError.new("No object_handler is attached to this object") unless @object_handler
+      raise ArgumentError, "No object_handler is attached to this object" unless @object_handler
+
       @object_handler.delete(@id)
     end
 
@@ -46,18 +49,25 @@ module PlateApi::PlateObject
       to_s
     end
 
-    def method_missing(m, *args, &block)
-      if attributes[m.to_s]
-        return attributes[m.to_s]
-      elsif attributes["content"] && attributes["content"][m.to_s]
-        return attributes["content"][m.to_s]["value"]
+    def method_missing(method_name, *args, &block)
+      if attributes[method_name.to_s]
+        attributes[method_name.to_s]
+      elsif attributes["content"] && attributes["content"][method_name.to_s]
+        attributes["content"][method_name.to_s]["value"]
       else
         super
       end
     end
 
+    def respond_to_missing?(method_name, include_private = false)
+      return true if attributes[method_name.to_s]
+      return true if attributes["content"] && attributes["content"][method_name.to_s]
+
+      super
+    end
+
     def ==(other)
-      return other.id == @id && other.class == self.class
+      other.id == @id && other.class == self.class
     end
 
     private
@@ -72,56 +82,68 @@ module PlateApi::PlateObject
       @relations = relations
     end
 
-    def self.has_one(name, klass)
-      HasOneRelations[self.name] ||= {}
-      self.attr_accessor "#{name}_id"
-      HasOneRelations[self.name][name.to_s] = klass
-      define_has_one_method(name, klass)
-    end
+    def set_relation_ids(relations_attributes)
+      HasOneRelations[self.class.name] ||= {}
 
-    def self.define_has_one_method(name, klass)
-      define_method(name.to_s) do
-        id = self.send("#{name}_id")
-        return nil unless id
-        @object_handler.api_connector.handler(Object.const_get(klass)).find(id)
+      return unless relations_attributes
+
+      self.class::HasOneRelations[self.class.name].keys.each do |relation_name|
+        val = relations_attributes["#{relation_name}_id"]
+        if val
+          send("#{relation_name}_id=", val)
+        end
       end
     end
 
-    def self.has_many(plural_name, singular_name, klass, define_create_method=false)
-      HasManyRelations[self.name] ||= {}
-      HasManyRelations[self.name][plural_name.to_s] = klass
-      define_has_many_methods(plural_name, klass)
-      define_create_method(singular_name, klass) if define_create_method
-    end
+    class << self
+      private
 
-    def self.define_has_many_methods(plural_name, klass)
-      define_method(plural_name.to_s) do |params={}|
-        @object_handler.api_connector.handler(
-          Object.const_get(klass)
-        ).index(self.class, @id, params)
+      def has_one(name, klass)
+        HasOneRelations[self.name] ||= {}
+        attr_accessor("#{name}_id")
+        HasOneRelations[self.name][name.to_s] = klass
+        define_has_one_method(name, klass)
       end
 
-      define_method("#{plural_name}_total_count") do
-        @object_handler.api_connector.handler(
-          Object.const_get(klass)
-        ).index_total_count(self)
+      def define_has_one_method(name, klass)
+        define_method(name.to_s) do
+          id = send("#{name}_id")
+          return nil unless id
+
+          @object_handler.api_connector.handler(Object.const_get(klass)).find(id)
+        end
       end
-    end
 
-    def self.define_create_method(singular_name, klass)
-      define_method("create_#{singular_name}") do |create_attributes|
-        @object_handler.api_connector.handler(Object.const_get(klass)).create(self, create_attributes)
+      def has_many(plural_name, singular_name, klass, define_create_method = false)
+        HasManyRelations[name] ||= {}
+        HasManyRelations[name][plural_name.to_s] = klass
+        define_has_many_methods(plural_name, klass)
+        define_create_method(singular_name, klass) if define_create_method
       end
-    end
 
-    def set_relation_ids(relations_attributes)
-      HasOneRelations[self.class.name] ||= {}
+      def define_has_many_methods(plural_name, klass)
+        define_method(plural_name.to_s) do |params = {}|
+          @object_handler.api_connector.handler(
+            Object.const_get(klass)
+          ).index(self.class, @id, params)
+        end
 
-      return unless relations_attributes
-      self.class::HasOneRelations[self.class.name].keys.each do |relation_name|
-        val = relations_attributes["#{relation_name}_id"]
-        if val
-          send("#{relation_name}_id=", val)
+        define_method("#{plural_name}_total_count") do
+          @object_handler.api_connector.handler(
+            Object.const_get(klass)
+          ).index_total_count(self)
+        end
+
+        define_method("all_#{plural_name}") do |params = {}, &block|
+          @object_handler.api_connector.handler(
+            Object.const_get(klass)
+          ).index_block(self.class, @id, params, &block)
+        end
+      end
+
+      def define_create_method(singular_name, klass)
+        define_method("create_#{singular_name}") do |create_attributes|
+          @object_handler.api_connector.handler(Object.const_get(klass)).create(self, create_attributes)
         end
       end
     end

data/lib/plate_api/request.rb

@@ -12,9 +12,9 @@ module PlateApi
     HttpAdapter = Faraday.default_adapter
 
     def initialize(public_key, secret, method, path, custom_server = nil)
-      base_api_endpoint = custom_server ? custom_server : DefaultApiBaseEndpoint
+      base_api_endpoint = custom_server || DefaultApiBaseEndpoint
 
-      @connection = ::Faraday.new(url: base_api_endpoint) do |faraday|
+      @connection = ::Faraday.new(url: base_api_endpoint, request: { timeout: 900 }) do |faraday|
         extra_builder_options(faraday)
         faraday.adapter HttpAdapter
       end
@@ -33,12 +33,12 @@ module PlateApi
         extra_request_options(request)
       end
 
-      return case response_type
-             when :raw
-               return response.body
-             when :json
-               return JSON.parse(response.body)
-             end
+      case response_type
+      when :raw
+        response.body
+      when :json
+        JSON.parse(response.body)
+      end
     end
 
     def request_date
@@ -50,9 +50,9 @@ module PlateApi
                        "#{@connection.host}\n" +
                        "#{@connection.path_prefix}/#{@path}\n" +
                        "#{url_parameters}\n" +
-                       "#{request_date}"
+                       request_date.to_s
       signature = Base64.strict_encode64(OpenSSL::HMAC.digest("SHA512", @secret, string_to_sign))
-      return "hmac #{@public_key}:#{signature}"
+      "hmac #{@public_key}:#{signature}"
     end
 
     private
@@ -65,14 +65,12 @@ module PlateApi
       ""
     end
 
-    def extra_request_options(request)
-    end
+    def extra_request_options(request); end
 
-    def extra_builder_options(request)
-    end
+    def extra_builder_options(request); end
 
     def strip_path(path)
-      path.gsub(/^\/|\/$/, "")
+      path.gsub(%r{^/|/$}, "")
     end
   end
 end

data/lib/plate_api/response_error.rb

@@ -0,0 +1,5 @@
+module PlateApi
+  class ResponseError < StandardError
+
+  end
+end

data/lib/plate_api/version.rb

@@ -1,3 +1,3 @@
 module PlateApi
-  VERSION = "1.2.4"
+  VERSION = "1.2.8"
 end

data/lib/plate_api.rb

@@ -9,7 +9,7 @@ require "plate_api/delete_request"
 require "plate_api/post_request"
 require "plate_api/post_multipart_request"
 require "plate_api/put_request"
-require "plate_api/error"
+require "plate_api/response_error"
 
 
 module PlateApi

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plate_api
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.8
 platform: ruby
 authors:
 - David Kortleven
@@ -161,10 +161,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -175,7 +175,6 @@ files:
 - lib/plate_api.rb
 - lib/plate_api/connector.rb
 - lib/plate_api/delete_request.rb
-- lib/plate_api/error.rb
 - lib/plate_api/get_request.rb
 - lib/plate_api/object_handler.rb
 - lib/plate_api/plate_object/attachment.rb
@@ -196,6 +195,7 @@ files:
 - lib/plate_api/post_request.rb
 - lib/plate_api/put_request.rb
 - lib/plate_api/request.rb
+- lib/plate_api/response_error.rb
 - lib/plate_api/version.rb
 - plate_api.gemspec
 homepage: 

data/.byebug_history

@@ -1,48 +0,0 @@
-c
-MimeMagic.by_path(@full_path)
-MimemMagic.by_path(@full_path)
-@file
-@full_path
-c
-attributes
-m
-c
-attributes
-m
-c;m
-m
-c
-m
-c
-attributes
-s
-up
-s
-up
-s
-new_object.attributes
-c
-new_object.attributes
-new_object
-c
-full_path
-c
-n
-val.is_a? File
-val
-c
-val.is_a? File
-val
-parameters
-c
-site.id
-site = subject.find(5)
-c
-site.class.superclass
-site.class.methods
-site.class
-site.methods.class
-site.methods - Object.methods
-site.methods
-site.id
-site = subject.find(5)

data/lib/plate_api/error.rb

@@ -1,5 +0,0 @@
-module Error
-  class Response < StandardError
-
-  end
-end