lite-service 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e6494a1b7ccefe36f2aee1a17040806bb8c4d80a737a26d0e19fedecfd79b68
-  data.tar.gz: f03bbccc41398f75e59182e7177c580e7b54efa9e189795a2f4cf9665ab472bc
+  metadata.gz: fbffb01cc4f2a0cc3ed9c2581adf7f903208b1bf888a34740a9d12ee63ecf7c1
+  data.tar.gz: 41597b9d29fcd29af77c4ab5c10c1dd030193ef72433316a4d78fa93fb7ca348
 SHA512:
-  metadata.gz: 911d83e318b8878da98e35808b4121baf0c2661299eed3c8cc9e7fe94ce08faf8c867835a8f8ea059c53e41ea10ae4d4ef1e11316371001774eaf1f360f1cdc1
-  data.tar.gz: 9d292b6f38cd39b008c10f90c09bfc9aaa789851c4edc08a88bb122aa095896338e2a4aeb16bf5280e4cb4d47597844b4a82c6f891b90a5e61b417876a154d21
+  metadata.gz: 2549a3c693bab9643b2e917947f4c43bfb12714a35dd5947033a9b396df38c6f426d938f9b117d9db2a2b454147359f2c250ea825f481be51a8980b0ab59a8a9
+  data.tar.gz: b9f9720664c1cbd5188de94d02ad86324634d1477db0810d06a5de60de63615c1a7d02d1cfb9c0b651edd78a7cfedae00edc609874585248c0d7f290807a9515

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.1] - 2019-06-25
+### Changed
+- Changed command module to class so that it's inheritable
+
 ## [1.0.0] - 2019-06-24
 ### Added
 - Initial project version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-service (1.0.1)
+    lite-service (1.0.2)
       lite-errors
       lite-memoize
 

data/README.md

@@ -3,7 +3,8 @@
 [![Gem Version](https://badge.fury.io/rb/lite-service.svg)](http://badge.fury.io/rb/lite-service)
 [![Build Status](https://travis-ci.org/drexed/lite-service.svg?branch=master)](https://travis-ci.org/drexed/lite-service)
 
-Lite::Service provides an API for building service objects.
+Lite::Service provides an API for building command based service objects.
+It also has mixins for handling errors and memoization.
 
 ## Installation
 
@@ -24,45 +25,40 @@ Or install it yourself as:
 ## Table of Contents
 
 * [Setup](#setup)
-* [Usage](#usage)
+* [Base](#base)
+* [Errors](#errors)
+* [Memoize](#memoize)
 
 ## Setup
 
 Setting up the service object is very easy and provides a high level API for memoizing pre-resulted
 values and for surfacing errors.
 
-Learn more about using memoization subclass in [Lite::Memoize](https://github.com/drexed/lite-memoize)
-and errors subclass [Lite::Errors](https://github.com/drexed/lite-errors).
-
 ```ruby
-class SearchMovies < Lite::Service::Command
+class SearchMovies < Lite::Service::Base
 
   def initialize(name)
     @name = name
   end
 
-  # NOTE: This method is required to call the command
-  def run
+  # NOTE: This method is required
+  def command
     { generate_fingerprint => movies_by_name }
   end
 
   private
 
   def movies_by_name
-    cache.memoize { HTTP.get("http://movies.com?title=#{title}") }
+    HTTP.get("http://movies.com?title=#{title}")
   end
 
   def generate_fingerprint
-    Digest::MD5.hexdigest(find_by_name)
-  rescue
-    errors.add(:fingerprint, 'invalid movie name')
+    Digest::MD5.hexdigest(movies_by_name)
   end
 
 end
 ```
 
-## Usage
-
 **Caller**
 
 ```ruby
@@ -70,48 +66,97 @@ service = SearchMovies.new('Toy Story')
 service.called? #=> false
 service.call    #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
 service.called? #=> true
-service.run     #=> Returns a fresh uncached value
 
 # or
 
 service = SearchMovies.call('Toy Story')
 service.called? #=> true
+service.call    #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
+```
+
+**Result**
+
+```ruby
+service = SearchMovies.new('Toy Story')
+service.result  #=> nil
+
+service.call    #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
 service.result  #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
+
+service.recall! #=> Clears the call, cache, errors, and then re-performs the call
+service.result  #=> { 'fingerprint_2' => [ 'Toy Story 2', ... ] }
 ```
 
-**Cache**
+## Errors (optional)
+
+Learn more about using [Lite::Errors](https://github.com/drexed/lite-errors)
 
 ```ruby
-service = SearchMovies.call('Toy Story')
-service.cache #=> Lite::Memoize::Instance object
+class SearchMovies < Lite::Service::Base
+  include Lite::Service::Errors
+
+  # ... ommited ...
+
+  private
+
+  # Add a fingerprint error to the error pool
+  def generate_fingerprint
+    Digest::MD5.hexdigest(movies_by_name)
+  rescue
+    errors.add(:fingerprint, 'invalid md5 request value')
+  end
+
+end
 ```
 
-**Errors**
+**Methods**
 
 ```ruby
 service = SearchMovies.call('Toy Story')
+service.errors    #=> Lite::Errors::Messages object
+
 service.validate! #=> Raises Lite::Service::ValidationError if it has any errors
 service.valid?    #=> Alias for validate!
 
-service.errors    #=> Lite::Errors::Messages object
 service.errored?  #=> false
 service.success?  #=> true
 service.failure?  #=> Checks that it has been called and has errors
+
+service.result!   #=> Raises Lite::Service::ValidationError if it has any errors, if not it returns the result
 ```
 
-**Result**
+## Memoize (optional)
+
+Learn more about using [Lite::Memoize](https://github.com/drexed/lite-memoize)
 
 ```ruby
-service = SearchMovies.new('Toy Story')
-service.result  #=> nil
+class SearchMovies < Lite::Service::Base
+  include Lite::Service::Memoize
 
-service.call    #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
-service.result  #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
+  # ... ommited ...
 
-service.recall! #=> Clears the call, cache, errors, and then re-performs the call
-service.result  #=> { 'fingerprint_2' => [ 'Toy Story 2', ... ] }
+  private
 
-service.result! #=> Raises Lite::Service::ValidationError if it has any errors
+  # Sets the value in the cache
+  # Subsequent method calls gets the cached value
+  # This saves you the extra external HTTP.get call
+  def movies_by_name
+    cache.memoize { HTTP.get("http://movies.com?title=#{title}") }
+  end
+
+  # Gets the value in the cache
+  def generate_fingerprint
+    Digest::MD5.hexdigest(movies_by_name)
+  end
+
+end
+```
+
+**Methods**
+
+```ruby
+service = SearchMovies.call('Toy Story')
+service.cache #=> Lite::Memoize::Instance object
 ```
 
 ## Development

data/lib/lite/service.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-%w[version exception command].each do |name|
+%w[version exception errors memoize base].each do |name|
   require "lite/service/#{name}"
 end

data/lib/lite/service/base.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Lite
+  module Service
+    class Base
+
+      class << self
+
+        def call(*args)
+          klass = new(*args)
+          klass.call
+          klass
+        end
+
+      end
+
+      attr_reader :result
+
+      def initialize(*args)
+        @args = args
+      end
+
+      def call
+        raise Lite::Service::NotImplementedError unless defined?(command)
+        return @result if called?
+
+        @called = true
+        @result = command
+      end
+
+      def called?
+        @called ||= false
+      end
+
+      def recall!
+        @called = false
+        %i[cache errors].each { |mixin| send(mixin).clear if respond_to?(mixin) }
+        call
+      end
+
+    end
+  end
+end

data/lib/lite/service/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'lite/errors'
+
+module Lite
+  module Service
+    module Errors
+
+      def errors
+        @errors ||= Lite::Errors::Messages.new
+      end
+
+      def errored?
+        !errors.empty?
+      end
+
+      def fail!
+        raise Lite::Service::ValidationError
+      end
+
+      def failure?
+        called? && errored?
+      end
+
+      def result!
+        result if valid?
+      end
+
+      def success?
+        called? && !errored?
+      end
+
+      def validate!
+        return true if success?
+
+        fail!
+      end
+
+      alias valid? validate!
+
+    end
+  end
+end

data/lib/lite/service/memoize.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'lite/memoize'
+
+module Lite
+  module Service
+    module Memoize
+
+      def cache
+        @cache ||= Lite::Memoize::Instance.new
+      end
+
+    end
+  end
+end

data/lib/lite/service/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Service
 
-    VERSION ||= '1.0.1'
+    VERSION ||= '1.0.2'
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-service
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lite-errors
@@ -159,8 +159,10 @@ files:
 - bin/console
 - bin/setup
 - lib/lite/service.rb
-- lib/lite/service/command.rb
+- lib/lite/service/base.rb
+- lib/lite/service/errors.rb
 - lib/lite/service/exception.rb
+- lib/lite/service/memoize.rb
 - lib/lite/service/version.rb
 - lite-service.gemspec
 homepage: http://drexed.github.io/lite-service

data/lib/lite/service/command.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require 'lite/errors'
-require 'lite/memoize'
-
-module Lite
-  module Service
-    class Command
-
-      class << self
-
-        def call(*args)
-          klass = new(*args)
-          klass.call
-          klass
-        end
-
-      end
-
-      attr_reader :result
-
-      def initialize(*args)
-        @args = args
-      end
-
-      def call
-        raise Lite::Service::NotImplementedError unless defined?(run)
-        return @result if called?
-
-        @called = true
-        @result = run
-      end
-
-      def cache
-        @cache ||= Lite::Memoize::Instance.new
-      end
-
-      def called?
-        @called ||= false
-      end
-
-      def errors
-        @errors ||= Lite::Errors::Messages.new
-      end
-
-      def errored?
-        !errors.empty?
-      end
-
-      def fail!
-        raise Lite::Service::ValidationError
-      end
-
-      def failure?
-        called? && errored?
-      end
-
-      def recall!
-        @called = false
-        [cache, errors].each(&:clear)
-        call
-      end
-
-      def result!
-        result if valid?
-      end
-
-      def success?
-        called? && !errored?
-      end
-
-      def validate!
-        return true if success?
-
-        fail!
-      end
-
-      alias valid? validate!
-
-    end
-  end
-end