apicasso_brush 0.1.0b → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d687264e478c7398bac882c02edd348896975b1e4fda478a14fb1531d977a36
-  data.tar.gz: cba93721ac292c43fc66c46ecebe66bac92a54ca6f2c1f9a278ecc48527a35b7
+  metadata.gz: 8b19e94043a6ffdbb970fdcb3d2d7a278e11100a08c430265706df50346b352c
+  data.tar.gz: 8c09dc87c6fbe6385282b872ff68526019c5aedad7a47ff118becbdfb175cb09
 SHA512:
-  metadata.gz: 9ad23ef2f60ba6aa4467707d449bec97b1f2349df7518c41c1fb5e911e02562c63c04bdc7d622fb383acb3004fb43d8193f3ee5e83eb19400493d9820a426075
-  data.tar.gz: ac979f16a84c275f6370b16800b911eefe5695fb852364c52c6248238dbb7408a21ae8039f749238d0c73dc4371892b4af322bd898c6d7e906fe8259fc9609c3
+  metadata.gz: d2b972d420190fc42d1a07a026473467617726ceb3f7d3b0daf958b31ca1a06f06956a40316221d52a8a641608c08d289c26b3f88ae61d8f066e2e2fead1d72f
+  data.tar.gz: 02b45578d4324c291827f1523e21e479ace990383d9b3a506566d5fd2be6db0e4986b22bad61acb8c21b897d5adafecfdb71beca6ede21a7306ff32f14a2591b

data/lib/apicasso/brush.rb

@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+module Apicasso
+  # A module to inject Autoracing data consumption behavior
+  class Brush
+    # A plugger to classes on a service using APIcasso.
+    # Receives the URL to get an object from the API.
+    def self.brush_on(resource_url = nil, opts = {})
+      if resource_url.nil?
+        raise Exception, "Configuration error.\nYou should pass the URL for your APIcasso resource as the first parameter\n# => brush_on 'https://my.api/path/to/resource'"
+      elsif opts[:token].nil?
+        raise Exception, "Configuration error.\nYou should pass a token option to authenticate.\n# => brush_on 'https://my.api/path/to/resource', token: '5e1o5ba77ca7f0d4'"
+      end
+
+      # Interface into options set on initialization
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        # Token used to connect into resource's APIcasso instance
+        def self.apicasso_token
+          "#{opts[:token]}"
+        end
+        # Base URL to resource, used to query from APIcasso instance
+        def self.resource_url
+          "#{resource_url}"
+        end
+        # Method that sets a default include query on this resource
+        def self.getter_include
+          "include=#{opts[:include].try(:map, &:to_s).try(:join, ',')}" if "#{opts[:include]}".present?
+        end
+      RUBY
+    end
+
+    # Constructor that can receive the ID of the object to search as first parameter
+    # and/or object attributes as second parameters
+    def initialize(id = nil, object = {})
+      @object = object
+      @id = id || object[:id]
+      instantiate if id.present? && !object.present?
+    end
+
+    # Instantiates the object by getting it from APIcasso
+    def instantiate
+      objectify! URI.parse(getter_url)
+    end
+
+    # Base getter URL for current resource
+    def getter_url
+	    self.class.resource_url + @id.to_s + '?' + self.class.getter_include.to_s
+    end
+
+    # Attributes from this object
+    def attributes
+      @object
+    end
+
+    # Overriding `method_missing` to enable fields being retrieved from @object
+    def method_missing(meth, *args, &block)
+      @object[meth.to_sym] || super
+    end
+
+    # Reloads the object by getting from APIcasso
+    def reload!
+      instantiate if @id.present?
+    end
+
+    # Reloads @object variable by receiving the URL used to get the object
+    def objectify!(url)
+      @object = get_object(url)
+    end
+
+    # Saves current object to APIcasso
+    def save
+      @object = save_object(URI.parse(getter_url)) if @object.is_a? Hash
+      @id = @object[:id]
+    end
+
+    # Updates current object to APIcasso
+    def update(opts = {})
+      @object.merge(opts)
+      @object = save_object(URI.parse(getter_url)) if @object.is_a? Hash
+      @id = @object[:id]
+    end
+
+    # Create objects, either using batch or individual request.
+    def self.update(opts = {})
+      if opts.is_a? Array
+        url = URI.parse("#{resource_url.chomp('/' + resource_url.split('/').last)}/batch_update")
+        http = Net::HTTP.new(url.host, url.port)
+
+        brush_collection(JSON.parse(retrieve(http, patch_request(url)).read_body))
+      elsif opts.is_a? Hash
+        object = find(opts[:id])
+        object.update(opts)
+      end
+    end
+
+    # Lists all objects from APIcasso of this class.
+    # Can receive a hash of parameters to be passed
+    # as query string into the APIcasso instance
+    def self.all(opts = {})
+      query = "?per_page=-1#{url_encode(opts)}&#{self.getter_include}"
+      url = URI.parse("#{resource_url}#{query}")
+      http = Net::HTTP.new(url.host, url.port)
+
+      response = JSON.parse(retrieve(http, get_request(url)).read_body).deep_symbolize_keys
+      brush_collection(response)
+    end
+
+    # Create objects, either using batch or individual request.
+    def self.create(opts = {})
+      if opts.is_a? Array
+        url = URI.parse("#{resource_url.chomp('/' + resource_url.split('/').last)}/batch_create")
+        http = Net::HTTP.new(url.host, url.port)
+
+        brush_collection(JSON.parse(retrieve(http, post_request(url, opts)).read_body))
+      else
+        http = Net::HTTP.new(url.host, url.port)
+        url = URI.parse(resource_url.to_s)
+
+        new(nil, JSON.parse(retrieve(http, post_request(url, opts)).read_body))
+      end
+    end
+
+    # Finds object based on opts finder, if no record is find it
+    # creates one using individual request.
+    def self.find_or_create_by(opts = {})
+      raise ::Exception, 'Pass attributes as hash' unless opts.is_a? Hash
+
+      object = nil
+      unless object = find_by(opts)
+        object = create(opts)
+      end
+      object
+    end
+
+    # Finds a object based on attributes conditions
+    def self.find_by(opts = {})
+      where(opts)[:entries][0]
+    end
+
+    # Finds a object based on attributes conditions,
+    # raises not found exception when query has no match
+    def self.find_by!(opts = {})
+      object = find_by(opts)
+      raise ::Exception, 'Not Found' if object.nil?
+    end
+
+    # Finds a resource with the given id
+    def self.find(id)
+      new(id)
+    end
+
+    # Returns an array of objects that matches a given query,
+    # which is the first parameter. This query can be a string of an
+    # ransack URL query or a hash where the keys would be *_eq operators.
+    def self.where(query = '', opts = {})
+      query = "?per_page=-1#{stringfy_ransackable(query)}#{url_encode(opts)}&#{getter_include}"
+      url = URI.parse("#{resource_url}#{query}")
+      http = Net::HTTP.new(url.host, url.port)
+
+      response = JSON.parse(retrieve(http, get_request(url)).read_body).deep_symbolize_keys
+      brush_collection(response)
+    end
+
+    # Destroys current object on APIcasso
+    def destroy
+      @object = @id = delete_object(URI.parse(getter_url))
+    end
+
+    alias delete destroy
+
+    private
+
+    def get_object(url)
+      http = Net::HTTP.new(url.host, url.port)
+      JSON.parse(self.class.retrieve(http, self.class.get_request(url)).read_body).deep_symbolize_keys
+    end
+
+    def save_object(url)
+      http = Net::HTTP.new(url.host, url.port)
+      meth = (@id.present? ? 'patch' : 'post')
+      JSON.parse(self.class.retrieve(http, self.class.send("#{meth}_request", url, @object)).read_body).deep_symbolize_keys
+    end
+
+    def delete_object(url)
+      http = Net::HTTP.new(url.host, url.port)
+      self.class.retrieve(http, self.class.delete_request(url))
+    end
+
+    class << self
+      def stringfy_ransackable(query = nil)
+        if query.is_a? String
+          '&' + query
+        elsif query.is_a? Hash
+          '&q={' + query.map do |key, value|
+            "\"#{key}_eq\": \"#{value}\""
+          end.join(',') + '}'
+        end
+      end
+
+      def url_encode(query = {})
+        return if query.nil?
+
+        '&' + query.map do |key, value|
+          "#{key}=#{value}"
+        end.join('&')
+      end
+
+      def retrieve(http, request)
+        response = http.request(request)
+        check_success response.code
+        response
+      end
+
+      def check_success(status)
+        case status
+        when '404', 404
+          raise ::Exception, 'Resource not found, are you sure you have configured your `brush_on` URL'
+        when '401', 401
+          raise ::Exception, 'Invalid Token'
+        when '403', 403
+          raise ::Exception, "Not authorized to #{request::METHOD} on resource"
+        else
+          raise ::Exception, 'Error when fetching from APIcasso' if status.to_i > 400
+        end
+      end
+
+      def delete_request(url)
+        request = Net::HTTP::Delete.new(url)
+        request['Authorization'] = "Token token=#{apicasso_token}"
+        request
+      end
+
+      def get_request(url)
+        request = Net::HTTP::Get.new(url)
+        request['Authorization'] = "Token token=#{apicasso_token}"
+        request
+      end
+
+      def patch_request(url, body)
+        request = Net::HTTP::Patch.new(url)
+        request['Authorization'] = "Token token=#{apicasso_token}"
+        request['Content-Type'] = 'application/json'
+        request.body = { name.underscore => body }.to_json
+        request
+      end
+
+      def post_request(url, body)
+        request = Net::HTTP::Post.new(url)
+        request['Authorization'] = "Token token=#{apicasso_token}"
+        request['Content-Type'] = 'application/json'
+        request.body = { name.underscore => body }.to_json
+        request
+      end
+
+      def brush_collection(response)
+        (response.is_a?(Hash) ? response[:entries] : response).map do |object|
+          new(nil, object)
+        end
+      end
+    end
+  end
+end

data/lib/apicasso_brush.rb

@@ -1,204 +1,7 @@
 # frozen_string_literal: true
 
-require "apicasso_brush/railtie"
+require 'apicasso_brush/railtie'
+require 'apicasso/brush'
 
-module Apicasso
-  # A module to inject Autoracing data consumption behavior
-  class Brush
-    # A plugger to classes on a service using APIcasso.
-    # Receives the URL to get an object from the API.
-    def self.brush_on(resource_url = nil, opts = {})
-      if resource_url.nil?
-        raise Exception.new("Configuration error.\nYou should pass the URL for your APIcasso resource as the first parameter\n# => brush_on 'https://my.api/path/to/resource'")
-      elsif opts[:token].nil?
-        raise Exception.new("Configuration error.\nYou should pass a token option to authenticate.\n# => brush_on 'https://my.api/path/to/resource', token: '5e1o5ba77ca7f0d4'")
-      end
-
-      # Interface into options set on initialization
-      class_eval <<-RUBY, __FILE__, __LINE__+1
-        # Token used to connect into resource's APIcasso instance
-        def self.apicasso_token
-          "#{opts[:token]}"
-        end
-        # Base URL to resource, used to query from APIcasso instance
-        def self.resource_url
-          "#{resource_url}"
-        end
-        # Method that sets a default include query on this resource
-        def getter_include
-          "?include=#{opts[:include].try(:map, &:to_s).try(:join, ',')}" if "#{opts[:include]}".present?
-        end
-      RUBY
-    end
-
-    # Constructor that can receive the ID of the object to search as first parameter
-    # and/or object attributes as second parameters
-    def initialize(id = nil, object = {})
-      @object = object
-      @id = id || object[:id]
-      instantiate if id.present? && !object.present?
-    end
-
-    # Instantiates the object by getting it from APIcasso
-    def instantiate
-      objectify! URI.parse(getter_url)
-    end
-
-    # Base getter URL for current resource
-    def getter_url
-      self.class.resource_url + @id.to_s + getter_include.to_s
-    end
-
-    # Attributes from this object
-    def attributes
-      @object
-    end
-
-    # Reloads the object by getting from APIcasso
-    def reload!
-      instantiate if @id.present?
-    end
-
-    # Reloads @object variable by receiving the URL used to get the object
-    def objectify!(url)
-      @object = get_object(url)
-    end
-
-    # Overrides method missing so that it points attribute
-    # getters and setters into the object itself
-    def method_missing(meth, *args, &block)
-      if meth.to_s.ends_with?('=')
-        @object[meth.to_s.delete('=').to_sym] = args.first
-      else
-        @object[meth.to_sym]
-      end
-    rescue StandardError
-      super
-    end
-
-    # Avoid inconsistencies on respond_to? calls
-    def respond_to_missing?(meth, include_private = false)
-      meth.to_s.ends_with?('=') || @object.key?(meth) || super
-    end
-
-    # Saves current object to APIcasso
-    def save
-      @object = save_object(URI.parse(getter_url)) if @object.is_a? Hash
-      @id = @object[:id]
-    end
-
-    # Lists all objects from APIcasso of this class.
-    # Can receive a hash of parameters to be passed
-    # as query string into the APIcasso instance
-    def self.all(opts = {})
-      query = "?per_page=-1#{url_encode(opts)}"
-      url = URI.parse("#{self.resource_url}#{query}")
-      http = Net::HTTP.new(url.host, url.port)
-
-      JSON.parse(retrieve(http, get_request(url)).read_body).deep_symbolize_keys.tap do |response|
-        response[:entries] = response[:entries].map { |object| Lead.new(nil, object) }
-      end
-    end
-
-    # Finds a resource with the given id
-    def self.find(id)
-      new(id)
-    end
-
-    # Returns an array of objects that matches a given query,
-    # which is the first parameter. This query can be a string of an
-    # ransack URL query or a hash where the keys would be *_eq operators.
-    def self.where(query = "", opts = {})
-      query = "?per_page=-1#{stringfy_ransackable(query)}#{url_encode(opts)}"
-      url = URI.parse("#{self.resource_url}#{query}")
-      http = Net::HTTP.new(url.host, url.port)
-
-      JSON.parse(retrieve(http, get_request(url)).read_body).deep_symbolize_keys.tap do |response|
-        response[:entries] = response[:entries].map { |object| Lead.new(nil, object) }
-      end
-    end
-
-    private
-
-    def get_object(url)
-      http = Net::HTTP.new(url.host, url.port)
-
-      JSON.parse(self.class.retrieve(http, self.class.get_request(url)).read_body).deep_symbolize_keys
-    end
-
-    def save_object(url)
-      http = Net::HTTP.new(url.host, url.port)
-      meth = (@id.present? ? "patch" : "post")
-      JSON.parse(self.class.retrieve(http, self.class.send("#{meth}_request", url, @object)).read_body).deep_symbolize_keys
-    end
-
-    private_class_method :stringfy_ransackable, :url_encode, :retrieve,
-                         :check_success, :delete_request, :get_request,
-                         :patch_request, :post_request
-
-    def self.stringfy_ransackable(query = nil)
-      if query.is_a? String
-        '&' + query
-      elsif query.is_a? Hash
-        '&q={' + query.map do |key, value|
-          "\"#{key}_eq\": \"#{value}\""
-        end.join(',') + '}'
-      end
-    end
-
-    def self.url_encode(query = {})
-      return if query.nil?
-
-      '&' + query.map do |key, value|
-        "#{key}=#{value}"
-      end.join('&')
-    end
-
-    def self.retrieve(http, request)
-      response = http.request(request)
-      check_success response.code
-      response
-    end
-
-    def self.check_success(status)
-      case status
-      when '404', 404
-        raise ::Exception.new("Resource not found, are you sure you have configured your `brush_on` URL")
-      when '401', 401
-        raise ::Exception.new("Invalid Token")
-      when '403', 403
-        raise ::Exception.new("Not authorized to #{request::METHOD} on resource")
-      else
-        raise ::Exception.new("Error when fetching from APIsso")
-      end
-    end
-
-    def self.delete_request(url)
-      request = Net::HTTP::Delete.new(url)
-      request['Authorization'] = "Token token=#{apicasso_token}"
-      request
-    end
-
-    def self.get_request(url)
-      request = Net::HTTP::Get.new(url)
-      request['Authorization'] = "Token token=#{apicasso_token}"
-      request
-    end
-
-    def self.patch_request(url, body)
-      request = Net::HTTP::Patch.new(url)
-      request['Authorization'] = "Token token=#{apicasso_token}"
-      request['Content-Type'] = 'application/json'
-      request.body = { name.underscore => body }.to_json
-      request
-    end
-
-    def self.post_request(url, body)
-      request = Net::HTTP::Post.new(url)
-      request['Authorization'] = "Token token=#{apicasso_token}"
-      request['Content-Type'] = 'application/json'
-      request.body = { name.underscore => body }.to_json
-      request
-    end
-  end
-end
+module ApicassoBrush
+end

data/lib/apicasso_brush/version.rb

@@ -1,3 +1,3 @@
 module ApicassoBrush
-  VERSION = '0.1.0b'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,22 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: apicasso_brush
 version: !ruby/object:Gem::Version
-  version: 0.1.0b
+  version: 0.1.1
 platform: ruby
 authors:
 - Fernando Bellincanta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
-dependencies: []
-description: |-
-  This is a client to consume data from microservices built upon [APIcasso](https://github.com/ErvalhouS/apicasso). It makes PORO classes supercharged by injecting Rails-like behavior through the methods:
-
-   - `find()`
-   - `all()`
-   - `where()`
-   - `save`
+date: 2019-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Instead of translating method calls into ORM, APIcasso Brush retrieves
+  it's data from your configured service. This makes it possible to make a convergent
+  application, that gets data from multiple API sources.
 email:
 - ervalhous@hotmail.com
 executables: []
@@ -26,11 +50,12 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- lib/apicasso/brush.rb
 - lib/apicasso_brush.rb
 - lib/apicasso_brush/railtie.rb
 - lib/apicasso_brush/version.rb
 - lib/tasks/apicasso_brush_tasks.rake
-homepage: https://github.com/ErvalhouS/APIcasso_Brush
+homepage: https://github.com/ErvalhouS/apicasso_brush
 licenses:
 - MIT
 metadata: {}
@@ -45,13 +70,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
-summary: Consume your APIcasso microservices
+summary: 'APIcasso Brush is a client to consume data from microservices built upon
+  APIcasso. It makes PORO classes supercharged by injecting Rails-like behavior through
+  the methods:'
 test_files: []