mini_service 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e819cb6201d5918ccdc7905773d5be0702ffedd68be9f124055213478af8987
+  data.tar.gz: d3bd75d54c0e92e3c7c4fa2a41cdcb60228106f627f21a20e5ffa9e8e3d8b11f
+SHA512:
+  metadata.gz: 43459572a9839d4ea529b76cb109f665e70b331ef77acf66f51e7040b5fd8de7adfdacad7ddcb338b1a9e0bb7af2302622079f3130792b4e8da6815a44fc2a01
+  data.tar.gz: 7a503cb92018de678a4aba44f6a04574ed54081e42d12fcd9c4ede1100e508caaad19ef1e929a4839578ef616bc73a7765e8422aa9837da9a29239fe191a9184

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+example.rb

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    mini_service (0.1.0)
+      activesupport (~> 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.11)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    irb (1.0.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  irb
+  mini_service!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Rodrgo Andrés Contreras Vilina
+
+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,125 @@
+# MiniService
+MiniServices are a prototype from which to build single-functionality
+ minimalistic services, aiming to
+help you correctly modularize and isolate your processes making them easier to
+mantain and less prone to
+errors.
+
+## TL;DR
+Define them like this:
+```ruby
+class ExampleService < MiniService::Base
+  mini_requires %i[a1 a2]
+  mini_allows %i[a3 a4]
+
+  private
+
+  def perform
+    # THIS IS WHAT YOUR SERVICE WILL DO AND RETURN
+  end
+end
+```
+
+Call them like this:
+```ruby
+ExampleService.call(a1: 1, a2: 2) # or
+ExampleService.call(a1: 1, a2: 2, a3: 3, a4: 4)
+# Instance variables will be available for each key-value pair
+# so you can use @a1 inside perform if a1 is given in the args hash
+```
+
+Adding `mini_reqs` will raise an error if you miss `reqd` arguments
+
+Adding `mini_lets` will raise an error if you add arguments not `letd` or `reqd`
+
+**ALWAYS** pass arguments in a hash.
+
+## Usage
+You can create your own services by inheriting from `MiniService::Base` class.
+
+Your `MiniServices` should be used via their `call` method, providing arguments
+in a hash, like
+`ExampleService.call(p1: v1, p2: v2)` or `ExampleService.call(args)` with args
+built elsewhere.
+
+This will automatically initialize your service with one `@instance_variable`
+for each `key-value` pair
+you've given.
+
+So for example a service like this:
+```ruby
+class ExampleService < MiniService::Base
+  private
+
+  def perform
+    # TODO: put your service logic in here~!!
+  end
+end
+```
+
+when called like this: `ExampleService.call(ex: true, ample: 1)`, would have
+both `@ex = true` and
+`@ample = 1` set.
+
+The `perform` method you see in the example, is the only method that will be
+run when you `call` a
+`MiniService`; that is, all your logic should be put there, and the final
+result should be `return`ed as the
+service's response.
+
+Also, `MiniServices` provide a nice way of declaring which arguments should be
+required and let through, raising errors when this conditions are not met.
+You can declare them using `mini_reqs` and `mini_lets` methods on your class'
+definition, giving them each an array of symbols.
+
+```ruby
+class ExampleService < MiniService::Base
+  mini_reqs %i[a1 a2]
+  mini_lets %i[a3 a4]
+
+  private
+
+  ···
+
+end
+```
+
+So it would raise `MissingArguments` or `UnallowedArguments` if you miss `a1`
+or add `a5` respectively
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini-service'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install mini-service
+```
+
+## Contributing
+If you wan't to contribute you can contact me via github or directly fork the
+repository and then make a
+pull request.
+For now, I'll only accept improvements on the code or functionality directly
+mentioned in the Next Changes
+section.
+
+## Next Changes
+Adding a simple generator for the service, that works by using
+`rails generate mini_service YourServiceName`
+to create a template file inside your app/services
+directory with the provided name.
+
+Also, testing the whole service.
+
+## License
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

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 "mini_service"
+
+# 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(__FILE__)

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/mini_service/base.rb

@@ -0,0 +1,9 @@
+require 'mini_service/class_methods.rb'
+require 'mini_service/instance_methods'
+
+module MiniService
+  class Base
+    extend  MiniService::ClassMethods
+    include MiniService::InstanceMethods
+  end
+end

data/lib/mini_service/class_methods.rb

@@ -0,0 +1,20 @@
+require 'active_support'
+module MiniService
+  module ClassMethods
+    def call(*args)
+      raise MiniService::ArgumentsNotHashError unless args[0].is_a?(Hash)
+
+      new(*args).call
+    end
+
+    def mini_reqs(array)
+      mattr_accessor :reqd_args
+      self.reqd_args = array
+    end
+
+    def mini_lets(array)
+      mattr_accessor :letd_args
+      self.letd_args = array
+    end
+  end
+end

data/lib/mini_service/errors.rb

@@ -0,0 +1,5 @@
+module MiniService
+  class MissingArgumentsError < StandardError; end
+  class UnallowedArgumentsError < StandardError; end
+  class ArgumentsNotHashError < StandardError; end
+end

data/lib/mini_service/instance_methods.rb

@@ -0,0 +1,53 @@
+require 'mini_service/errors'
+
+module MiniService
+  module InstanceMethods
+    def initialize(args)
+      instance_variables(args)
+    end
+
+    def call
+      perform
+    end
+
+    private
+
+    def instance_variables(args)
+      raise MiniService::MissingArgumentsError if missing_arguments?(args)
+
+      args.each do |key, value|
+        raise MiniService::ExtraArgumentsError unless argument_allowed?(key)
+
+        instance_variable_set "@#{key}", value
+      end
+    end
+
+    def argument_allowed?(key)
+      @alwd_args ||= allowed_arguments
+      return true if @alwd_args.empty?
+
+      @alwd_args.include? key
+    end
+
+    def allowed_arguments
+      alwd_args = []
+      alwd_args << letd_args if letd_args_defined?
+      alwd_args << reqd_args if reqd_args_defined?
+      alwd_args.flatten
+    end
+
+    def missing_arguments?(args)
+      return false unless reqd_args_defined?
+
+      (reqd_args - args.keys).any?
+    end
+
+    def reqd_args_defined?
+      !defined?(reqd_args).nil?
+    end
+
+    def letd_args_defined?
+      !defined?(letd_args).nil?
+    end
+  end
+end

data/lib/mini_service/version.rb

@@ -0,0 +1,3 @@
+module MiniService
+  VERSION = '0.0.0'.freeze
+end

data/lib/mini_service.rb

@@ -0,0 +1,8 @@
+require 'mini_service/version'
+# require 'mini_service/class_methods'
+# require 'mini_service/instance_methods'
+require 'mini_service/base'
+# require 'mini_service/errors'
+
+module MiniService
+end

data/mini_service.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mini_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'mini_service'
+  spec.version  = MiniService::VERSION
+  spec.authors  = ['Rodrgo Andrés Contreras Vilina']
+  spec.email    = ['roanvilina@gmail.com']
+
+  spec.summary  = 'Provides a simple service prototype class and its generator.'
+  spec.homepage = 'https://github.com/roanvilina/mini_service'
+  spec.license  = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'irb'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'activesupport', '~> 4.2.0'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: mini_service
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Rodrgo Andrés Contreras Vilina
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: 
+email:
+- roanvilina@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mini_service.rb
+- lib/mini_service/base.rb
+- lib/mini_service/class_methods.rb
+- lib/mini_service/errors.rb
+- lib/mini_service/instance_methods.rb
+- lib/mini_service/version.rb
+- mini_service.gemspec
+homepage: https://github.com/roanvilina/mini_service
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Provides a simple service prototype class and its generator.
+test_files: []