apicasso_brush 0.1.0b

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d687264e478c7398bac882c02edd348896975b1e4fda478a14fb1531d977a36
+  data.tar.gz: cba93721ac292c43fc66c46ecebe66bac92a54ca6f2c1f9a278ecc48527a35b7
+SHA512:
+  metadata.gz: 9ad23ef2f60ba6aa4467707d449bec97b1f2349df7518c41c1fb5e911e02562c63c04bdc7d622fb383acb3004fb43d8193f3ee5e83eb19400493d9820a426075
+  data.tar.gz: ac979f16a84c275f6370b16800b911eefe5695fb852364c52c6248238dbb7408a21ae8039f749238d0c73dc4371892b4af322bd898c6d7e906fe8259fc9609c3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Fernando Bellincanta
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# APIcasso Brush [![Build Status](https://travis-ci.com/ErvalhouS/apicasso_brush.svg?branch=master)](https://travis-ci.com/ErvalhouS/apicasso_brush) [![Maintainability](https://api.codeclimate.com/v1/badges/5286908f324e1446e1ac/maintainability)](https://codeclimate.com/github/ErvalhouS/apicasso_brush/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/5286908f324e1446e1ac/test_coverage)](https://codeclimate.com/github/ErvalhouS/apicasso_brush/test_coverage) [![Inline docs](http://inch-ci.org/github/ErvalhouS/apicasso_brush.svg?branch=master)](http://inch-ci.org/github/ErvalhouS/apicasso_brush)
+## Consume your APIcasso microservices
+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`
+
+Instead of translating those 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.
+
+## Usage
+To start consuming from your services just create a class inheriting from `Apicasso::Brush` and declare how APIcasso should stroke the brush. First declare the base for current class, which is a index action from your API for the given resource, then pass a token that has access into that resource.
+
+```ruby
+class ModelFromService < Apicasso::Brush
+  brush_on 'http://my.service.com/model',
+           token: '5e1057e7a51ee7a55',
+           include: :a_relation, :a_method # Optional
+end
+```
+You can also by default include relations or methods that should get built into your `ModelFromService` objects.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apicasso_brush'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install apicasso_brush
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ApicassoBrush'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/apicasso_brush/railtie.rb

@@ -0,0 +1,4 @@
+module ApicassoBrush
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/apicasso_brush/version.rb

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

data/lib/apicasso_brush.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require "apicasso_brush/railtie"
+
+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

data/lib/tasks/apicasso_brush_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :apicasso_brush do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: apicasso_brush
+version: !ruby/object:Gem::Version
+  version: 0.1.0b
+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`
+email:
+- ervalhous@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Consume your APIcasso microservices
+test_files: []