api_service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 160cef037bed12f7c2ba17a17f5a4974c700c270
+  data.tar.gz: 2d224a81a522a3e1b50fa903751a76e993453363
+SHA512:
+  metadata.gz: 2dce24ee9bde816aa3872e1534598275f79582f68fbb70631d7a2f70c411c3f0acfb03991357629124cc591b6b879be0cfef6f3e6d9679071396dad9ef25fda9
+  data.tar.gz: e3c9a5aae6b78d10481de9df92c8b0e5657de8407b19043f6e03e813bd0d2fa786ce922f2a3997d7774082ed6d35253c1433eb4a8a17033e74381d9579b9e898

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea
+.DS_Store
+api_service-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.2
+before_install: gem install bundler -v 1.14.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bogdan Sviripa
+
+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,29 @@
+# ApiService
+
+Lightweight skeleton of service for API actions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_service
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bogdan-sviripa/api_service.
+
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/api_service.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'api_service'
+  spec.version       = ApiService::VERSION
+  spec.authors       = ['Bogdan Sviripa']
+  spec.email         = ['sviripa.work@gmail.com']
+
+  spec.summary       = 'Lightweight skeleton of service for API actions'
+  spec.description   = 'Lightweight skeleton of service for API actions'
+  spec.homepage      = 'https://github.com/bogdan-sviripa/api_service'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

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

@@ -0,0 +1,5 @@
+require 'api_service/version'
+require 'api_service/base'
+
+module ApiService
+end

data/lib/api_service/action.rb

@@ -0,0 +1,14 @@
+require 'api_service/base_action'
+
+module ApiService
+  class Action < BaseAction
+    def initialize(name, options, to_perform)
+      super(name, options)
+      @to_perform = to_perform
+    end
+
+    def perform(params, state)
+      @to_perform.call(params, state)
+    end
+  end
+end

data/lib/api_service/action_state.rb

@@ -0,0 +1,49 @@
+require 'api_service/error_manager'
+require 'api_service/failed_result'
+require 'api_service/successful_result'
+
+module ApiService
+  class ActionState
+    attr_reader :response
+
+    def initialize(initial_state = {})
+      @response = nil
+      @state = initial_state
+      @error_manager = ErrorManager.new
+    end
+
+    def add_current_action(action, is_last = false)
+      @current_action = action
+      @is_current_action_last = is_last
+    end
+
+    def action
+      @current_action
+    end
+
+    def valid?
+      !errors.any?
+    end
+
+    def errors
+      @error_manager
+    end
+
+    def set(field, value)
+      @state[field] = value
+    end
+
+    def fetch(field)
+      @state[field]
+    end
+
+    def build_failed_response
+      @response = FailedResult.new(self)
+    end
+
+    def success(response = {}, options = {})
+      return unless @is_current_action_last
+      @response = SuccessfulResult.new(response, self, options)
+    end
+  end
+end

data/lib/api_service/base.rb

@@ -0,0 +1,42 @@
+require 'api_service/action'
+require 'api_service/action_state'
+
+module ApiService
+  class Base
+    class << self
+      def actions
+        @actions ||= []
+      end
+
+      def add_shared_action(name, shared_action, options = {})
+        actions << shared_action.new(name, options)
+      end
+
+      def add_action(name, options = {}, &action_body)
+        actions << Action.new(name, options, action_body)
+      end
+    end
+
+    def initialize(params, initial_state = {})
+      @response = nil
+      @params = params
+      @state = ActionState.new(initial_state)
+    end
+
+    def perform
+      actions_pool = self.class.actions
+      actions_pool.each_with_index do |action, index|
+        @state.add_current_action(action, index == actions_pool.size - 1)
+
+        action.perform(@params, @state)
+
+        if !@state.valid? && action.abort_on_fail?
+          @state.build_failed_response
+          break
+        end
+      end
+
+      @state.response
+    end
+  end
+end

data/lib/api_service/base_action.rb

@@ -0,0 +1,27 @@
+module ApiService
+  class BaseAction
+    attr_reader :options
+
+    def initialize(name, options)
+      @options = default_options.merge(options)
+      @name = name
+    end
+
+    def abort_on_fail?
+      !@options[:permissive]
+    end
+
+    def fail_http_status
+      @options[:fail_http_status]
+    end
+
+    private
+
+    def default_options
+      {
+        permissive: false,
+        fail_http_status: 422
+      }
+    end
+  end
+end

data/lib/api_service/error_manager.rb

@@ -0,0 +1,46 @@
+module ApiService
+  class ErrorManager
+    def initialize
+      @errors = {}
+    end
+
+    def any?
+      @errors.any?
+    end
+
+    def add(field, message, scope = '')
+      in_scope(scope) do |errors|
+        field = field.to_sym
+        errors[field] ||= []
+        errors[field] << message
+        errors
+      end
+    end
+
+    def to_hash
+      @errors
+    end
+
+    def from_model(model)
+      model.errors.messages.each do |field, errors|
+        @errors[field] ||= []
+        @errors[field] = @errors[field].concat(errors).uniq
+      end
+    end
+
+    private
+
+    def in_scope(scope)
+      return unless block_given?
+
+      keys = scope.to_s.split('.')
+      @errors = yield(@errors) if keys.empty?
+
+      keys.inject(@errors) do |hash, key|
+        hash[key] ||= {}
+        yield(hash[key]) if key == keys.last
+        hash[key]
+      end
+    end
+  end
+end

data/lib/api_service/failed_result.rb

@@ -0,0 +1,17 @@
+module ApiService
+  class FailedResult
+    attr_reader :state
+
+    def initialize(state)
+      @state = state
+    end
+
+    def response
+      { errors: @state.errors.to_hash }
+    end
+
+    def http_status
+      @state.action.fail_http_status
+    end
+  end
+end

data/lib/api_service/successful_result.rb

@@ -0,0 +1,23 @@
+module ApiService
+  class SuccessfulResult
+    attr_reader :state, :response
+
+    def initialize(response, state, options = {})
+      @options = default_options.merge(options)
+      @response = response
+      @state = state
+    end
+
+    def http_status
+      @options[:http_status]
+    end
+
+    private
+
+    def default_options
+      {
+        http_status: 201
+      }
+    end
+  end
+end

data/lib/api_service/version.rb

@@ -0,0 +1,3 @@
+module ApiService
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: api_service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bogdan Sviripa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Lightweight skeleton of service for API actions
+email:
+- sviripa.work@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_service.gemspec
+- bin/console
+- bin/setup
+- lib/api_service.rb
+- lib/api_service/action.rb
+- lib/api_service/action_state.rb
+- lib/api_service/base.rb
+- lib/api_service/base_action.rb
+- lib/api_service/error_manager.rb
+- lib/api_service/failed_result.rb
+- lib/api_service/successful_result.rb
+- lib/api_service/version.rb
+homepage: https://github.com/bogdan-sviripa/api_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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Lightweight skeleton of service for API actions
+test_files: []
+has_rdoc: