activegraphql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 657360098f58cecb708293738e5ecf43bc40890e
+  data.tar.gz: 51e15e8a81e7100617f665ec94b4cc4b27612546
+SHA512:
+  metadata.gz: 9a5233fa7a1e4d9a6f31202d751a24b4fd145f09552958885d4913cce9cb2f20bc2e29c25cbcd200b13c3bb9ffb8ca94d88599ad5c331407b27606063b2cfef9
+  data.tar.gz: 496784159351d5efbbde0cc844ab09d6db13d8f3e4ca4d4d6270abe151069d3ade3a2258451291be49a9da69c1e8ffe6d5327199a87bd67a7f07e5e9092fd270

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activegraphql.gemspec
+gemspec
+
+gem 'byebug', group: [:development, :test]
+gem 'rspec-its', group: [:test]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 aviscasillas
+
+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,74 @@
+# ActiveGraphQL
+
+[![Build Status](https://travis-ci.org/wakoopa/activegraphql.png)](https://travis-ci.org/wakoopa/activegraphql)
+
+ActiveGraphQL connects classes to [GraphQL](http://graphql.org/) services.
+The library provides a **Model** class that, when subclassed and configured, encapsulates the communication with the service.
+
+```ruby
+class MyModel < ActiveGraphQL::Model
+  configure url: 'http://some-graphql-service/endpoint'
+end
+```
+
+Any subclass of `ActiveGraphQL::Model` will provide the following methods:
+
+- **all:** Retrive all objects for the entity.
+- **where(conditions):** Retrieve all objects for the entity finding by conditions.
+- **find_by(conditions):** Retrieve first object for the entity finding by conditions.
+
+Any one of these methods returns an `ActiveGraphQL::Fetcher` who provides the method `fetch(*graph)` that is responsible of calling the service. The `*graph` arguments allow to specify how the response format will be.
+
+For convention, any method is performing a call to the service with a query, that is resolved based on: model class name, conditions and graph.
+
+**Retrieving all `MyModel` objects (just ask for retrieving `id`)**
+
+```ruby
+>> MyModel.all.fetch(:id).first.id
+=> "1"
+```
+
+Resolved query:
+
+```
+{ myModels { id } }
+```
+
+**Retrieving all `MyModel` objects with `value == "a"` (ask for `id` and `name`)**
+
+```ruby
+>> m = MyModel.where(value: 'a').fetch(:id, :name).first
+
+>> m.id
+=> "3"
+
+>> m.name
+=> "Whatever"
+```
+
+Resolved query:
+
+```
+{ myModels("value": "a") { id, name } }
+```
+
+**Retrieving `MyModel` object with `id == "5"` (ask for `id`, `name` and `nestedObject { id }`)**
+
+```ruby
+>> m = MyModel.find_by(id: '5').fetch(:id, :name, nested_object: [:description])
+
+>> m.id
+=> "5"
+
+>> m.name
+=> "Whatever"
+
+>> m.nested_object.description
+=> "Some description here"
+```
+
+Resolved query:
+
+```
+{ myModel("id": "5") { id, name, nestedObject { description } } }
+```

data/Rakefile

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

data/activegraphql.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activegraphql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activegraphql'
+  spec.version       = ActiveGraphQL::VERSION
+  spec.authors       = ['Wakoopa']
+  spec.email         = ['info@wakoopa.com']
+
+  spec.summary       = %q{Ruby client for GraphQL services}
+  spec.description   = %q{}
+  spec.homepage      = 'https://github.com/wakoopa/active-graphql'
+  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 'hashie', '~> 3.4'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'httparty', '~> 0.13'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activegraphql"
+
+# 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/lib/activegraphql.rb

@@ -0,0 +1,5 @@
+require 'active_support'
+require 'activegraphql/version'
+require 'activegraphql/query'
+require 'activegraphql/fetcher'
+require 'activegraphql/model'

data/lib/activegraphql/fetcher.rb

@@ -0,0 +1,28 @@
+require 'activegraphql/support/fancy'
+
+module ActiveGraphQL
+  class Fetcher < Support::Fancy
+    attr_accessor :url, :klass, :action, :params, :query
+
+    class Error < StandardError; end
+
+    def initialize(attrs)
+      super(attrs)
+      self.query = Query.new(url: url, action: action, params: params)
+    end
+
+    def fetch(*graph)
+      response = query.get(*graph)
+      return if response.blank?
+
+      case response
+      when Hash
+        klass.new(response)
+      when Array
+        response.map { |h| klass.new(h) }
+      else
+        fail Error, "Unexpected response for query: #{response}"
+      end
+    end
+  end
+end

data/lib/activegraphql/model.rb

@@ -0,0 +1,59 @@
+require 'active_support/core_ext'
+require 'hashie/mash'
+
+module ActiveGraphQL
+  class Model < ::Hashie::Mash
+    class Error < StandardError; end
+
+    class << self
+      attr_accessor :url
+
+      # This provides ability to configure the class inherited from here.
+      #  Also field classes will have the configuration.
+      #
+      #  Example:
+      #    class BaseModelToMyService < ActiveGraphql::Model
+      #      configure url: 'http://localhost:3000/graphql'
+      #    end
+      #
+      #    class ModelToMyService < BaseModelToMyService
+      #    end
+      #
+      #    BaseModelToMyService.url
+      #    => "http://localhost:3000/graphql"
+      #
+      #    ModelToMyService.url
+      #    => "http://localhost:3000/graphql"
+      def configure(url: nil)
+        configurable_class.url = url
+      end
+
+      # Resolves the class who is extending from ActiveGraphql::Model.
+      #
+      #  This provides the capability for configuring inheritable classes with
+      #  specific configuration to the corresponding graphql service.
+      def configurable_class
+        ancestors[ancestors.find_index(ActiveGraphQL::Model) - 1]
+      end
+
+      def all
+        build_fetcher(name.demodulize.underscore.pluralize.to_sym)
+      end
+
+      def where(conditions = {})
+        build_fetcher(name.demodulize.underscore.pluralize.to_sym, conditions)
+      end
+
+      def find_by(conditions = {})
+        build_fetcher(name.demodulize.underscore.to_sym, conditions)
+      end
+
+      def build_fetcher(action, params = nil)
+        Fetcher.new(url: configurable_class.url,
+                    klass: self,
+                    action: action,
+                    params: params)
+      end
+    end
+  end
+end

data/lib/activegraphql/query.rb

@@ -0,0 +1,80 @@
+require 'httparty'
+require 'active_support/inflector'
+require 'activegraphql/support/fancy'
+
+module ActiveGraphQL
+  class Query < Support::Fancy
+    attr_accessor :url, :action, :params, :graph, :response
+
+    class ServerError < StandardError; end
+
+    def get(*graph)
+      self.graph = graph
+
+      self.response = HTTParty.get(url, query: { query: to_s })
+
+      raise(ServerError, response_error_messages) if response_errors.present?
+      response_data
+    end
+
+    def response_data
+      return unless response['data']
+      to_snake_case(response['data'][qaction])
+    end
+
+    def response_errors
+      to_snake_case(response['errors'])
+    end
+
+    def response_error_messages
+      response_errors.map { |e| e[:message] }
+    end
+
+    def to_s
+      str = "{ #{qaction}"
+      str << (qparams.present? ? "(#{qparams}) {" : ' {')
+      str << " #{qgraph(graph)} } }"
+      str
+    end
+
+    def qaction
+      action.to_s.camelize(:lower)
+    end
+
+    def qparams
+      return if params.blank?
+
+      param_strings = params.map do |k, v|
+        "#{k.to_s.camelize(:lower)}: \"#{v}\""
+      end
+
+      param_strings.join(', ')
+    end
+
+    def qgraph(graph)
+      graph_strings = graph.map do |item|
+        case item
+        when Symbol
+          item.to_s.camelize(:lower)
+        when Hash
+          item.map { |k, v| "#{k.to_s.camelize(:lower)} { #{qgraph(v)} }" }
+        end
+      end
+
+      graph_strings.join(', ')
+    end
+
+    private
+
+    def to_snake_case(value)
+      case value
+      when Array
+        value.map { |v| to_snake_case(v) }
+      when Hash
+        Hash[value.map { |k, v| [k.to_s.underscore.to_sym, to_snake_case(v)] }]
+      else
+        value
+      end
+    end
+  end
+end

data/lib/activegraphql/support/fancy.rb

@@ -0,0 +1,9 @@
+module ActiveGraphQL
+  module Support
+    class Fancy
+      def initialize(attrs = {})
+        attrs.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+    end
+  end
+end

data/lib/activegraphql/version.rb

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

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: activegraphql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wakoopa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-07 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: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: ''
+email:
+- info@wakoopa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activegraphql.gemspec
+- bin/console
+- bin/setup
+- lib/activegraphql.rb
+- lib/activegraphql/fetcher.rb
+- lib/activegraphql/model.rb
+- lib/activegraphql/query.rb
+- lib/activegraphql/support/fancy.rb
+- lib/activegraphql/version.rb
+homepage: https://github.com/wakoopa/active-graphql
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for GraphQL services
+test_files: []