inflect 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8951661906e8fea2c53b241c2ed44d49d7f4155f
-  data.tar.gz: e685535c15abc2f5f753f9c1ea42ed8d372edf89
+  metadata.gz: 0540c58850a8378d104c597d1082d334f153f907
+  data.tar.gz: 712d8e922f27c6f994dec37ea4542f69976002a7
 SHA512:
-  metadata.gz: 25ef3d073b0ab588ac592a502767345cc8dfb4a8454f777d98aa210bd78d59d2cbcd8004f9ff06cc814f513122f76b2372d2d054c1229231ac6b0fc99ea7e4dd
-  data.tar.gz: 8f181a6082230a3bf07145320597429314e6387dde91254603f7f9d441e0f547b6871155ddc01027ae7b1c4187d42e83d53a9adb75d5770bd0fad369f72349a6
+  metadata.gz: d5f79a0bd635f982577ae422d231b8a6af308fa736642522b7d7eae91114128a24d17505ffbfc698e3ee2c253db08f9cc291f8f094fe724c563289197b76046d
+  data.tar.gz: c7ef59e1152a2660d74047ca0e28919e9e113287e6ebe1d609089f8452db669e2e09c115d94c1639e586b8e07e7d193d6dc575414b90b5b940f0be3e245e74ab

data/README.md

@@ -30,7 +30,7 @@ Generate your Service:
 
     $ inflect generate:service Weather
 
-IMPORTANT: service name must be in CamelCase, example: 
+IMPORTANT: service name must be in CamelCase, example:
 
     $ inflect generate:service MyWeatherService
 
@@ -43,8 +43,20 @@ class WeatherService < Inflect::AbstractService
     @words    = %W[WEATHER TODAY]
   end
 
-  def handle(words)
-    respond "Weather for today is... very hot."
+  # This method will be executed whenever the action is not defined in the
+  # words query array.
+  def default
+    respond "This is the default weather cast"
+  end
+
+  # This is method will be called when the action TODAY is present in
+  # the words query array. It can optionally carry necessary arguments.
+  def today(location = nil)
+    if location.nil?
+      respond "Weather for today is... very hot."
+    else
+      respond "The weather for #{location} is... also very hot."
+    end
   end
 end
 ```

data/lib/generators/service_generator.rb

@@ -9,7 +9,7 @@ class ServiceGenerator < Thor::Group
 	# Include Inflector for string management utils such
 	# as camelize.
 	using Inflect::Inflector
-	
+
 	# Defines the templates path.
 	def self.source_root
 		File.join(File.dirname(__FILE__), 'templates')

data/lib/generators/templates/service.tt

@@ -1,20 +1,27 @@
 class <%= name %>Service < Inflect::AbstractService
-  # A WORDS Array constant with the key words of the Service.
+  # A WORDS Array constant with the key words of the Service,
+  # the first word of the array represents the keyword for the
+  # service, the second represents the action (method), and all the rest are
+  # the arguments to that action.
   # @example Array for New York Times service
-  #   words = %W[ NEWS TODAY NEW\ YORK\ TIMES]
+  #   words = %W[NEWS TODAY NEW\ YORK\ TIMES]
+  #
+  # This would mean that the service would handle request with the
+  # keyword NEWS, in it's #today method with the arguments "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[]
+    @words    = %W[].freeze
   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)
+  # This method is the only one needed for Inflect to work.
+  # Implements how the service responds to a request that has no
+  # action attribute.
+  # @return Inflect::Response
+  def default
     super
   end
 end

data/lib/inflect/abstract_service.rb

@@ -30,21 +30,68 @@ module Inflect
       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.
+    # Receives a Request and returns true if the service can handle
+    # the request given.
+    # @param Inflect::Request
     # @return [Boolean]
-    def valid?(words)
-      (@words & words).any?
+    def valid?(request)
+      (self.keyword.eql? request.keyword) &&
+      action_defined(request.action)
     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."
+    # The +default+ is the method called when there is no action parameter inside
+    # the words query array.
+    def default
+      no_method_error
+    end
+
+    # Returns a Hash with retrieved data by routing from the request
+    # to the method specified by the request's action attribute.
+    # @param Inflect::Request
+    # @return Inflect::Response
+    def handle(request)
+      if action_defined(request.action) && !action_implemented(request.action)
+        no_method_error
+      else
+        if request.arguments.empty?
+          send request.action
+        else
+          send request.action, request.arguments
+        end
+      end
+    end
+
+    # Virtual attribute for the services keyword.
+    def keyword
+      words.first
+    end
+
+    # Virtual attributes for the service actions. Every action must
+    # have its matching method.
+    def actions
+      words[1..-1]
+    end
+
+    private
+
+    # Check if user defined the given action besides from the default_options
+    # action that is always present.
+    def action_defined(action)
+      (action.eql? :default) || (actions.include? action.to_s.upcase)
+    end
+
+    # Check if user really implemented the method corresponding to
+    # the action.
+    def action_implemented(action)
+      respond_to? action
+    end
+
+    # Method fired when users don't implement the method corresponding
+    # to the actions they define in the +words+ array.
+    def no_method_error
+      message = "#{self.class} declared the action #{request.action}
+             in #{self.words} but the method is missing, for more
+             information see Inflect::AbstractService class."
       raise NoMethodError.new message
     end
   end

data/lib/inflect/director.rb

@@ -1,5 +1,6 @@
 require 'inflect/loader'
 require 'inflect/configuration'
+require 'inflect/request'
 
 module Inflect
   # The class in charge of managing the access
@@ -20,19 +21,20 @@ module Inflect
     # the work.
     # @param words [Array<String, Symbol>]
     def handle(words)
-      selected_service = select_service(words)
+      request = Inflect::Request.new(words)
+      selected_service = select_service(request)
       if selected_service.nil?
-        raise "No service can respond to #{words.first}"
+        raise "No service can respond to #{request.keyword}"
       else
-        selected_service.serve(words)
+        selected_service.serve(request)
       end
     end
 
     private
 
-    def select_service(words)
+    def select_service(request)
       services.find do |service|
-        service.valid?(words)
+        service.valid? request
       end
     end
   end

data/lib/inflect/request.rb

@@ -0,0 +1,22 @@
+module Inflect
+  # Class that parses the incoming data and builds the semantics
+  # around the request.
+  class Request
+    attr_reader :keyword, :action, :arguments, :query_words
+    #
+    # The request is built from an array of words.
+    # Depending on the size the arguments and the action are built in a different
+    # ways.
+    # @example
+    #   %W[WEATHER] -> {service_key: weather, action: 'default'}
+    #   %W[WEATHER TODAY] -> {service_key: weather, action: 'today'}
+    #   %W[WEATHER TODAY BUENOS\ AIRES] -> {service_key: weather, action: 'today',
+    #   args: ['Buenos Aires']}
+    def initialize(words)
+      @query_words = words.dup
+      @keyword = words.shift
+      @action = words.first.nil? ? :default : words.shift.downcase.to_sym
+      @arguments = words.map(&:downcase)
+    end
+  end
+end

data/lib/inflect/responsive.rb

@@ -6,10 +6,10 @@ module Inflect
     # Method that creates Response instance.
     # @param words [Array<String>] The queried words.
     # @return [Inflect::Response | nil] Returns nil if response is not valid.
-    def serve(words)
-      content, options = handle(words)
-      opts = merge_options(options, { query_words: words })
-      response = validate_response(Inflect::Response.new(content, opts))
+    def serve(request)
+      content, options = handle(request)
+      opts = merge_options(options, { query_words: request.query_words })
+      validate_response(Inflect::Response.new(content, opts))
     end
 
     # Supply more expressiveness and flexibility to the interface

data/lib/inflect/version.rb

@@ -1,3 +1,3 @@
 module Inflect
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/services/random_service.rb

@@ -0,0 +1,27 @@
+class RandomService < Inflect::AbstractService
+  # A WORDS Array constant with the key words of the Service,
+  # the first word of the array represents the keyword for the
+  # service, the second represents the action (method), and all the rest are
+  # the arguments to that action.
+  # @example Array for New York Times service
+  #   words = %W[NEWS TODAY NEW\ YORK\ TIMES]
+  #
+  # This would mean that the service would handle request with the
+  # keyword NEWS, in it's #today method with the arguments "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 = 1
+    @words    = %W[RANDOM].freeze
+  end
+
+  # This method is the only one needed for Inflect to work.
+  # Implements how the service responds to a request that has no
+  # action attribute.
+  # @return Inflect::Response
+  def default
+    super
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inflect
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Santiago Figueiras
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-09 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,9 +110,11 @@ files:
 - lib/inflect/inflector.rb
 - lib/inflect/loader.rb
 - lib/inflect/locale/en.yml
+- lib/inflect/request.rb
 - lib/inflect/response.rb
 - lib/inflect/responsive.rb
 - lib/inflect/version.rb
+- lib/services/random_service.rb
 homepage: https://github.com/InflectProject/inflect
 licenses:
 - MIT
@@ -134,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Backend service API support for the inflect-client app.