inflect 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53be0693b9edb25da2858481d98e9320a8ee773e
+  data.tar.gz: cb1efab2840feceaf9b8f4119295b10f343239df
+SHA512:
+  metadata.gz: 59c2e062d1e474d70c7fb041ddf8a1d53012ad5cdcb8ae2d1ce5e7f58a7016f3c9dcaa006bce78f959bf8704326e71c7d9603b3ccf30ef5f71e06be392d56b9f
+  data.tar.gz: 6377e0c791fcdea3f0d41720f32fed16109c6f9e43768bd1c78fc0fa94778b2b8531d3c1c6eb8f29047f9838e843e7336ebf64498a8b5a952d395fe2de2a9376

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inflect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Santiago Figueiras
+
+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,78 @@
+# Inflect
+
+The micro-framework for service integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inflect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inflect
+
+## Usage
+
+Generate your Service:
+
+    $ bin/inflect generate:service weather
+
+Implement at least the ServiceWeather#handle method:
+
+```ruby
+class WeatherService < Inflect::AbstractService
+  def initialize
+    @priority = 2
+    @words    = %W[WEATHER TODAY]
+  end
+
+  def handle(words)
+    respond "Weather for today is... very hot."
+  end
+end
+```
+
+Call Inflect with the array of words.
+
+```ruby
+words = %W[WEATHER TODAY]
+
+Inflect.handle(words) # Return Response object with weather for today
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/inflect.
+We follow the Ruby best practices and community-driven standards well explained in bbatsov's ruby-style-guide, see https://github.com/bbatsov/ruby-style-guide.
+
+## Docs
+
+To generate docs run (if not installed):
+
+```ruby
+  gem install yard
+```
+Then to generate the docs:
+
+    $ yardoc
+
+To run doc server:
+
+    $ yard server
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'inflect'
+require 'generators/service_generator'
+
+CLI.start(ARGV)

data/bin/setup

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

data/inflect.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inflect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inflect"
+  spec.version       = Inflect::VERSION
+  spec.authors       = ["Santiago Figueiras",
+                        "Gastón Ambrogi"]
+  spec.email         = ["santi.figueiras95@gmail.com",
+                        "gastom.ambrogi@gmail.com"]
+
+  spec.summary       = %q{Backend service API support for the inflect-client app.}
+  spec.description   = %q{Integrate service API's by following a simple and modular interface.}
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/InflectProject/inflect"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["inflect"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+  spec.add_runtime_dependency "thor", "~> 0.19.1"
+end

data/lib/generators/service_generator.rb

@@ -0,0 +1,18 @@
+require "thor"
+
+class ServiceGenerator < Thor::Group
+	include Thor::Actions
+
+	def self.source_root
+		File.join(File.dirname(__FILE__), 'templates')
+	end
+
+	argument :name
+	def generate
+		template('service.tt', "lib/services/#{name}_service.rb")
+	end
+end
+
+class CLI < Thor
+	register ServiceGenerator, "generate:service", "generate:service <service_name>", "Generates a service skeleton."
+end

data/lib/generators/templates/service.tt

@@ -0,0 +1,20 @@
+class <%=name.capitalize%>Service < Inflect::AbstractService
+  # A WORDS Array constant with the key words of the Service.
+  # @example Array for New York Times service
+  #   words = %W[ NEWS TODAY NEW\ YORK\ TIMES]
+
+  # In case there are modules that provide similar contents the
+  # one with most PRIORITY is picked.
+  # Float::Infinity is the lowest priority.
+  def initialize
+    @priority = Float::INFINITY
+    @words    = %W[]
+  end
+
+  # This is method is the only one needed for Inflect to work.
+  # Implements how the service responds at the translated words.
+  # Returns a Inflect::Response with retrieved data.
+  def handle(words)
+    super
+  end
+end

data/lib/inflect/abstract_service.rb

@@ -0,0 +1,51 @@
+require 'singleton'
+require 'inflect/responsive'
+
+module Inflect
+  # Acts as an specification or standard required for a Service
+  # Class to be consumed by the application. A Service Class is
+  # just a wrapper for any possible service you'd like to give
+  # support to, just by having four prerequisites.
+  class AbstractService
+    include Comparable
+    include Singleton
+    include Responsive
+
+    # A +words+ Array constant with the key +words+ of the Service.
+    # @example Array for New York Times service
+    #   words = %W[ NEWS TODAY NEW\ YORK\ TIMES]
+    attr_reader :words
+
+    # In case there are modules that provide similar contents the
+    # one with most +priority+ is picked.
+    attr_reader :priority
+
+    def initialize
+      @priority = 0
+      @words    = []
+    end
+
+    # Implement Comparable in order to be sortable.
+    def <=> (other_service)
+      priority <=> other_service.priority
+    end
+
+    # Receives an Array of words and returns true or false depending
+    # if the Service can handle the request given by the words.
+    #
+    # @param words [Array] an Array of strings with key words.
+    # @return [Boolean]
+    def valid?(words)
+      (@words & words).any?
+    end
+
+    # Returns a Hash with retrieved data.
+    #
+    # @param words [Array] an Array of strings with key words.
+    def handle(words)
+      message = "#{self.class} must implement handle method,
+             for more information see AbstractService class."
+      raise NoMethodError.new message
+    end
+  end
+end

data/lib/inflect/configuration.rb

@@ -0,0 +1,24 @@
+module Inflect
+  class << self
+    attr_reader :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  # The class in charge of centralizing the application's
+  # configuration.
+  class Configuration
+    attr_reader :services_path, :locale_path
+
+    def initialize
+      @services_path = File.join(__dir__, 'services')
+      @locale_path   = File.join(File.dirname(__FILE__), 'locale/en.yml')
+    end
+  end
+end

data/lib/inflect/director.rb

@@ -0,0 +1,32 @@
+require 'inflect/loader'
+require 'inflect/configuration'
+
+module Inflect
+  # The class in charge of managing the access
+  # and selection of the services.
+  class Director
+    attr_reader :services
+
+    # @param services_path [String]
+    def initialize(services_path = nil)
+      @services = Loader.services(
+        services_path || Inflect.configuration.services_path
+      )
+    end
+
+    # Finds the first Service that is able
+    # to handle the request and lets him do
+    # the work.
+    # @param words [Array<String, Symbol>]
+    def handle(words)
+      selected_service = select_service(words)
+      selected_service.handle(words) unless selected_service.nil?
+    end
+
+    private
+
+    def select_service(words)
+      services.find { |service| service.valid?(words) }
+    end
+  end
+end

data/lib/inflect/i18n.rb

@@ -0,0 +1,12 @@
+require 'inflect/loader'
+
+module Inflect
+  # Responsible of internationalization logic in the app.
+  module I18n
+    # @param +key+ [Symbol, String] The key to error message.
+    # @return [String] Translation of the error message.
+    def self.errors(key)
+      Loader::locale['errors'][key.to_s]
+    end
+  end
+end

data/lib/inflect/inflector.rb

@@ -0,0 +1,13 @@
+module Inflect
+  module Inflector
+    # Redefine String methods in the context of the current
+    # scope, adding utility String methods such as #camelize.
+    refine String do
+      SNAKE_SEPARATOR = '_'
+
+      def camelize
+        self.split(SNAKE_SEPARATOR).map(&:capitalize!).join
+      end
+    end
+  end
+end

data/lib/inflect/loader.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+require 'inflect/inflector'
+require 'inflect/configuration'
+
+module Inflect
+  # Responsable for loading all the services for Inflect
+  # to comunicate with them and decide wich one will handle
+  # the request.
+  #
+  module Loader
+    using Inflector
+    # Loads all the services from the given path, sorted by
+    # PRIORITY from lowest (1) to highest (INFINITY).
+    #
+    # @param path [String] A String indicating the path to
+    #   the services directory.
+    # @return [Array] The Service Classes sorted by PRIORITY.
+    def self.services(path)
+      services = []
+
+      Dir["#{path}/*.rb"].each do |file|
+        require "#{file}"
+
+        filename = File.basename(file, '.rb')
+        services << Inflect.const_get(filename.camelize).instance
+      end
+      services.sort
+    end
+
+    def self.locale(path = nil)
+      @@locale ||= YAML.load_file(path || Inflect.configuration.locale_path)
+    end
+  end
+end

data/lib/inflect/locale/en.yml

@@ -0,0 +1,5 @@
+errors:
+  content: 'Content must be a String or Hash instance.'
+  served_by: 'Handled service reference is required.'
+  query_words: 'Queried words is required.'
+  handled_word: 'Handled words of service is required.'

data/lib/inflect/response.rb

@@ -0,0 +1,64 @@
+require 'inflect/loader'
+require 'inflect/i18n'
+
+module Inflect
+  #Responsible of encapsulate all the content of the service response
+  class Response
+    attr_reader :content, :attributes, :timestamp, :errors
+
+    # @param content [String, Hash] The response of the service. Required.
+    # @param description [Hash] Contains all the description of service response.
+    # @option description [Class] :served_by Handler Service. Instance of AbstractService. Required.
+    # @option description [Array<String>] :query_words The list of words received on the request. Required.
+    # @option description [String] :handled_word The handled word by the service. Required.
+    # @return [Inflect::Response]
+    def initialize(content=nil, description={})
+      @content        =   content
+      @timestamp      =   Time.now
+      @errors         =   {}
+      @attributes     =   extract_attributes(description)
+    end
+
+    def self.attribute_keys
+      @@attribute_keys = [:served_by, :query_words]
+    end
+
+    attribute_keys.each do |key|
+      define_method :"valid_attribute_#{key}" do
+        if attributes[key].nil?
+          errors[key] = I18n.errors(key)
+          return false
+        end
+        true
+      end
+      private :"valid_attribute_#{key}"
+    end
+
+    # Validates required attributes for a valid response.
+    # @return [true, false]
+    def valid?
+      private_methods.grep(/valid_attribute/).collect do |method_name|
+        self.send method_name
+      end.all?
+    end
+
+    private
+
+    def valid_attribute_content
+      unless [String, Hash].include? content.class
+        errors[:content] = I18n.errors('content')
+        return false
+      end
+      true
+    end
+
+    def extract_attributes(description={})
+      attributes = {}
+
+      self.class.attribute_keys.each do |key|
+        attributes.store key, description[key]
+      end
+      attributes
+    end
+  end
+end

data/lib/inflect/responsive.rb

@@ -0,0 +1,39 @@
+require 'inflect/response'
+
+module Inflect
+  # Allows services to respond an Inflect::Response instance.
+  module Responsive
+
+    # Method that creates Response instance.
+    # @param content [String, Hash] the response of the service.
+    # @return [Inflect::Response, nil] Returns nil if response is not valid.
+    def respond(content, options = {})
+      opts = merge_options(options)
+      validate_response(Inflect::Response.new(content, opts))
+    end
+
+    # Method that creates Response instance, skipping response validation.
+    # @param content [String, Hash] the response of the service.
+    # @return [Inflect::Response]
+    def respond!(content, options = {})
+      opts = merge_options(options)
+      Inflect::Response.new(content, opts)
+    end
+
+    private
+
+    def validate_response(response)
+      response.valid? ? response : nil
+    end
+
+    def merge_options(options)
+      default_options.merge(options)
+    end
+
+    # Set a Hash with required +option+ parameters for Inflect::Response.
+    # @return [Hash]
+    def default_options
+      {served_by: self.class}
+    end
+  end
+end

data/lib/inflect/version.rb

@@ -0,0 +1,3 @@
+module Inflect
+  VERSION = "0.2.2"
+end

data/lib/inflect.rb

@@ -0,0 +1,18 @@
+require "inflect/version"
+require "inflect/director"
+require "inflect/configuration"
+require "inflect/abstract_service"
+
+module Inflect
+  class << self
+    def handle(words)
+      director.handle(words)
+    end
+
+    private
+
+    def director
+      @@director ||= Director.new(self.configuration.services_path)
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: inflect
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Santiago Figueiras
+- Gastón Ambrogi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+description: Integrate service API's by following a simple and modular interface.
+email:
+- santi.figueiras95@gmail.com
+- gastom.ambrogi@gmail.com
+executables:
+- inflect
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/inflect
+- bin/setup
+- inflect.gemspec
+- lib/generators/service_generator.rb
+- lib/generators/templates/service.tt
+- lib/inflect.rb
+- lib/inflect/abstract_service.rb
+- lib/inflect/configuration.rb
+- lib/inflect/director.rb
+- lib/inflect/i18n.rb
+- lib/inflect/inflector.rb
+- lib/inflect/loader.rb
+- lib/inflect/locale/en.yml
+- lib/inflect/response.rb
+- lib/inflect/responsive.rb
+- lib/inflect/version.rb
+homepage: https://github.com/InflectProject/inflect
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Backend service API support for the inflect-client app.
+test_files: []
+has_rdoc: