grape-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de222ff72b1fd8635c6551dda5832a403a867955
+  data.tar.gz: b708ca40554c08395acaf0c75e45f38233ca04a4
+SHA512:
+  metadata.gz: fc3cf3857176e2e3d02e2cf1e0cc2299921301287c228060e0234a46f67f671a7f3d4b1f585e5da26fb1049c68ba1cb08be426c648f17bd7d956cf4b9acfda32
+  data.tar.gz: 420adb29ac9fb753d150c46efb8f922d9b49e7a73529f54c35ab2ecca17311a49472d7f5eb603dcf583fc355b68eb6b4265a17f2ebb35b98f5c5c7ba0771d1d8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+# This is the configuration used to check the rubocop source code.
+
+inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-03-22 11:41:17 +0200 using RuboCop version 0.37.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 104
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 9
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/grape_client.rb'
+    - 'lib/grape_client/accessors.rb'
+    - 'lib/grape_client/base.rb'
+    - 'lib/grape_client/cache.rb'
+    - 'lib/grape_client/collection.rb'
+    - 'lib/grape_client/connection.rb'
+    - 'lib/grape_client/response_parser.rb'
+    - 'lib/grape_client/rest_methods_collection.rb'
+    - 'lib/grape_client/rest_methods_member.rb'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rubocop', '~> 0.37.0'
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec', '~> 3.4.0'
+  gem 'vcr', '~> 3.0.0'
+  gem 'webmock', '~> 1.22.0'
+  gem 'codeclimate-test-reporter', require: nil
+end
+
+# Specify your gem's dependencies in grape_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 DeSofto
+
+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,32 @@
+# GrapeClient
+[![Build Status](https://travis-ci.org/desofto/grape-client.svg?branch=master)](https://travis-ci.org/desofto/grape-client)
+[![Code Climate](https://codeclimate.com/github/desofto/grape-client/badges/gpa.svg)](https://codeclimate.com/github/desofto/grape-client)
+[![Test Coverage](https://codeclimate.com/github/desofto/grape-client/badges/coverage.svg)](https://codeclimate.com/github/desofto/grape-client/coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-client
+
+## Usage
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/desofto/grape-client.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'grape_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grape-client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-client'
+  spec.version       = GrapeClient::VERSION
+  spec.authors       = ['Dmitry Silchenko']
+  spec.email         = ['dmitry@desofto.com']
+
+  spec.summary       = 'Simple access from your client to Grape APIs.'
+  spec.description   = 'Simple access from your client to Grape APIs.'
+  spec.homepage      = 'https://github.com/desofto/grape-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency('activesupport', '~> 4.2')
+end

data/lib/grape_client.rb

@@ -0,0 +1,12 @@
+require 'grape_client/version'
+require 'active_support/all'
+
+module GrapeClient
+  $LOAD_PATH.unshift(File.dirname(__FILE__))
+
+  Dir["#{File.dirname(__FILE__)}/grape_client/*.rb"].each do |f|
+    file = File.basename(f, File.extname(f))
+
+    autoload file.camelize, "grape_client/#{file}"
+  end
+end

data/lib/grape_client/accessors.rb

@@ -0,0 +1,14 @@
+module GrapeClient
+  module Accessors
+    def mattr_accessor(*attr_names)
+      attr_names.each do |attr_name|
+        define_singleton_method(attr_name) do
+          class_variable_get("@@#{attr_name}")
+        end
+        define_singleton_method("#{attr_name}=") do |value|
+          class_variable_set("@@#{attr_name}", value)
+        end
+      end
+    end
+  end
+end

data/lib/grape_client/base.rb

@@ -0,0 +1,81 @@
+module GrapeClient
+  class Base
+    extend Accessors
+    mattr_accessor :site, :user, :password, :prefix
+
+    extend RestMethodsCollection
+    include RestMethodsMember
+
+    attr_reader :attributes
+
+    class << self
+      def field_accessor(*names)
+        attributes = self.attributes
+        names.each do |name|
+          attributes << name.to_sym
+        end
+      end
+
+      def connection
+        @connection ||= Connection.new(user, password)
+      end
+
+      def cache
+        Cache.instance
+      end
+
+      def entity_name
+        name.split('::').last.underscore
+      end
+
+      def endpoint
+        site + prefix + entity_name.pluralize
+      end
+
+      def attributes
+        class_variable_set('@@attributes', []) unless class_variable_defined?('@@attributes')
+        class_variable_get('@@attributes')
+      end
+    end
+
+    def initialize(attrs = {})
+      @attributes = {}
+      self.attributes = attrs
+    end
+
+    def attributes=(attrs)
+      attributes = self.class.attributes
+      attrs.each do |name, value|
+        next unless attributes.include? name.to_sym
+        send("#{name}=", value)
+      end
+    end
+
+    def [](name)
+      name = name.to_sym
+      raise NameError, name unless self.class.attributes.include? name
+      @attributes[name]
+    end
+
+    def []=(name, value)
+      name = name.to_sym
+      raise NameError, name unless self.class.attributes.include? name
+      @attributes[name] = value
+    end
+
+    def method_missing(m, *args)
+      m = m.to_s
+      if m.last == '='
+        name = m[0..-2]
+        self[name] = args.first
+      else
+        self[m]
+      end
+    end
+
+    def to_post
+      entity_name = self.class.entity_name
+      attributes.transform_keys { |key| "#{entity_name}[#{key}]" }
+    end
+  end
+end

data/lib/grape_client/cache.rb

@@ -0,0 +1,40 @@
+module GrapeClient
+  class Cache
+    def initialize
+      clear
+    end
+
+    def clear
+      @objects = {}
+    end
+
+    def fetch(params)
+      id = params.is_a?(Hash) ? params[:id] : params
+      object = @objects[id] if id.present?
+      unless object.present?
+        object = yield
+        store(object)
+      end
+      object
+    end
+
+    def store(object)
+      id = object.try(:id)
+      return unless id.present?
+      @objects[id] = object
+    end
+
+    def remove(object)
+      id = object.try(:id)
+      return unless id.present?
+      @objects[id] = nil
+    end
+
+    @instance = Cache.new
+    private_class_method :new
+
+    class << self
+      attr_reader :instance
+    end
+  end
+end

data/lib/grape_client/collection.rb

@@ -0,0 +1,101 @@
+module GrapeClient
+  class Collection
+    attr_reader :count
+
+    def initialize(clazz, elements, headers = nil)
+      @is_first_page = true
+      @clazz = clazz
+      update(elements, headers)
+    end
+
+    def first
+      @clazz.new(@elements.first) if @elements.any?
+    end
+
+    def each(&_block)
+      prepare_for_iteration
+      loop do
+        @elements.each do |attrs|
+          yield @clazz.new(attrs)
+        end
+        break unless load_next_page
+      end
+    end
+
+    def map(&_block)
+      prepare_for_iteration
+      result = []
+      loop do
+        result += @elements.map do |attrs|
+          yield @clazz.new(attrs)
+        end
+        break unless load_next_page
+      end
+      result
+    end
+
+    def collect
+      prepare_for_iteration
+      result = []
+      loop do
+        result += @elements
+        break unless load_next_page
+      end
+      result
+    end
+
+    private
+
+    def update(elements, headers = nil)
+      @elements = elements
+      @count = headers['total'].first.try(:to_i) if headers
+      @count ||= @elements.length
+      @first_page_link = extract_first_page_link(headers)
+      @next_page_link = extract_next_page_link(headers)
+    end
+
+    def prepare_for_iteration
+      return if @is_first_page
+      load_first_page
+    end
+
+    def load_next_page
+      return unless load_page @next_page_link
+      @is_first_page = false
+      true
+    end
+
+    def load_first_page
+      return unless load_page @first_page_link
+      @is_first_page = true
+      true
+    end
+
+    def load_page(link)
+      return unless link.present?
+      response = @clazz.connection.request :get, link
+      update ResponseParser.new(response, @clazz).collection, @clazz.connection.headers
+      true
+    end
+
+    def extract_first_page_link(headers)
+      extract_page_link(headers, 'first')
+    end
+
+    def extract_next_page_link(headers)
+      extract_page_link(headers, 'next')
+    end
+
+    def extract_page_link(headers, title)
+      return unless headers.present?
+      links = headers['link'].try(:first)
+      return unless links.present?
+      links = links.split(',').map do |link|
+        link = link.split(';').map(&:strip)
+        link.delete("rel=\"#{title}\"") ? link : nil
+      end.compact.flatten
+      return unless links.any?
+      links.first[1..-2]
+    end
+  end
+end

data/lib/grape_client/connection.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+
+module GrapeClient
+  class Connection
+    class UndefinedMethod < StandardError; end
+    class Unauthorized < StandardError; end
+    class InvalidEntity < StandardError; end
+    class UnknownError < StandardError; end
+
+    attr_reader :headers
+
+    def initialize(user, password)
+      @user = user
+      @password = password
+    end
+
+    def request(method, url, params = {})
+      uri = prepare_uri(method, url, params)
+      req = prepare_request(method, uri, params)
+
+      res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request(req)
+      end
+
+      @headers = res.to_hash
+      validate_response res
+    end
+
+    private
+
+    def prepare_uri(method, url, params = {})
+      uri = URI(url)
+      if params.any? && [:get, :delete].include?(method.to_sym)
+        uri.query = URI.encode_www_form(params)
+      end
+
+      uri
+    end
+
+    def prepare_request(method, uri, params = {})
+      req = connector(method).new(uri)
+      req.basic_auth @user, @password
+      if params.any? && [:put, :post].include?(method.to_sym)
+        req.set_form_data(params)
+      end
+
+      req
+    end
+
+    def validate_response(res)
+      case res
+      when Net::HTTPUnauthorized        then raise Unauthorized
+      when Net::HTTPSuccess             then res.body
+      when Net::HTTPUnprocessableEntity then raise InvalidEntity
+      else raise UnknownError, res.body
+      end
+    end
+
+    def connector(method)
+      case method.to_sym
+      when :get     then Net::HTTP::Get
+      when :put     then Net::HTTP::Put
+      when :post    then Net::HTTP::Post
+      when :delete  then Net::HTTP::Delete
+      else raise UndefinedMethod
+      end
+    end
+  end
+end

data/lib/grape_client/response_parser.rb

@@ -0,0 +1,40 @@
+require 'json'
+
+module GrapeClient
+  class ResponseParser
+    def initialize(response, receiver)
+      @response = response
+      @receiver = receiver
+    end
+
+    def parse
+      if @receiver.is_a? Class
+        elements = collection
+        if elements.nil?
+          if parsed.present?
+            @receiver.new(parsed)
+          else
+            @response
+          end
+        else
+          Collection.new(@receiver, elements,
+                         @receiver.connection.headers)
+        end
+      else
+        @receiver.attributes = parsed
+      end
+    end
+
+    def collection
+      parsed[@receiver.entity_name.pluralize] if parsed.is_a? Hash
+    end
+
+    private
+
+    def parsed
+      @parsed ||= JSON.parse @response
+    rescue JSON::ParserError
+      nil
+    end
+  end
+end

data/lib/grape_client/rest_methods_collection.rb

@@ -0,0 +1,60 @@
+module GrapeClient
+  module RestMethodsCollection
+    def create(attrs)
+      object = new(attrs)
+      object.save!
+      object
+    end
+
+    def all
+      get
+    end
+
+    def find(params)
+      if params.is_a? Hash
+        cache.fetch(params) do
+          result = get(nil, params)
+          result.is_a?(Collection) ? result.first : result
+        end
+      else
+        cache.fetch(params) do
+          get(params)
+        end
+      end
+    end
+
+    def where(conditions)
+      get(nil, conditions)
+    end
+
+    protected
+
+    def get(method = nil, params = {}, &block)
+      request :get, method, params, &block
+    end
+
+    def put(method = nil, params = {}, &block)
+      request :put, method, params, &block
+    end
+
+    def post(method = nil, params = {}, &block)
+      request :post, method, params, &block
+    end
+
+    def delete(method = nil, params = {}, &block)
+      request :delete, method, params, &block
+    end
+
+    private
+
+    def request(method, url, params = {}, &_block)
+      url = [endpoint, url].compact.join('/')
+      response = connection.request method, url, params
+      if block_given?
+        yield response
+      else
+        ResponseParser.new(response, self).parse
+      end
+    end
+  end
+end

data/lib/grape_client/rest_methods_member.rb

@@ -0,0 +1,54 @@
+module GrapeClient
+  module RestMethodsMember
+    def save!
+      if id.present?
+        put(nil, to_post)
+      else
+        post(nil, to_post) do |response|
+          ResponseParser.new(response, self).parse
+        end
+      end
+      self.class.cache.store(self)
+    end
+
+    def save
+      save!
+    rescue Connection::InvalidEntity
+      false
+    end
+
+    def reload
+      get(nil) do |response|
+        ResponseParser.new(response, self).parse
+      end
+      self.class.cache.store(self)
+      self
+    end
+
+    def destroy
+      self.class.cache.remove(self)
+      delete
+    end
+
+    protected
+
+    def get(method, params = {}, &block)
+      method = [id, method].compact.join('/')
+      self.class.send(:get, method, params, &block)
+    end
+
+    def put(method, params = {}, &block)
+      method = [id, method].compact.join('/')
+      self.class.send(:put, method, params, &block)
+    end
+
+    def post(method, params = {}, &block)
+      method = [id, method].compact.join('/')
+      self.class.send(:post, method, params, &block)
+    end
+
+    def delete(params = {}, &block)
+      self.class.send(:delete, id, params, &block)
+    end
+  end
+end

data/lib/grape_client/version.rb

@@ -0,0 +1,3 @@
+module GrapeClient
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: grape-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Silchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Simple access from your client to Grape APIs.
+email:
+- dmitry@desofto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grape-client.gemspec
+- lib/grape_client.rb
+- lib/grape_client/accessors.rb
+- lib/grape_client/base.rb
+- lib/grape_client/cache.rb
+- lib/grape_client/collection.rb
+- lib/grape_client/connection.rb
+- lib/grape_client/response_parser.rb
+- lib/grape_client/rest_methods_collection.rb
+- lib/grape_client/rest_methods_member.rb
+- lib/grape_client/version.rb
+homepage: https://github.com/desofto/grape-client
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Simple access from your client to Grape APIs.
+test_files: []