nano-service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc688f4a3949cd84be9b748db5f42c569d693522
+  data.tar.gz: b285cb214644219c6feed790455d83cab4788770
+SHA512:
+  metadata.gz: 0dac73f7d3cd219a3cb6c90dda46d3a6e37ca617f6a05de900c19b5d6a0a774ec92ef56894fa1d633d6eb443f00aae280f1bc11d56b4d50691628b7c2fecd9bf
+  data.tar.gz: 38433e47d1dc439dc1635d96802b347912959a36a68b7112e43c121c68f20f27fbf194e0fce7fd0459f7ba740a2319513cfd1adc5b9807041313b88378bf827b

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+.DS_Store
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at daveriess@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+ruby '2.2.3'
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec',    '~> 3.4'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dave Riess
+
+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,8 @@
+[![Build Status](https://circleci.com/gh/wunderteam/nano-service.svg?style=svg)](https://circleci.com/gh/wunderteam/nano-service)
+
+# NanoService Prototype
+A thin module wrapper for helping enforce service boundaries.
+
+# TODO
+- additional test coverage for dynamic exception definition
+- explore options for more flexible exception mapping

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 "nano-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

data/lib/nano-service.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+require 'active_record'
+require 'globalid'
+
+require 'nano-service/error_serializer'
+require 'nano-service/exceptions'
+require 'nano-service/version'
+require 'nano-service/base'
+
+module NanoService
+end

data/lib/nano-service/base.rb

@@ -0,0 +1,68 @@
+module NanoService
+  module Base
+    extend ActiveSupport::Concern
+
+    # dynamically define NanoService exceptions on the including Service module
+    included do
+      @namespace = Kernel.const_get(name.split('::')[0])
+
+      nano_service_exceptions = NanoService.constants.select do |c|
+        klass = NanoService.const_get(c)
+        (klass.class === Class) && (klass < StandardError)
+      end
+
+      (nano_service_exceptions - @namespace.constants).each do |e|
+        @namespace.const_set(e, NanoService.const_get(e))
+      end
+    end
+
+    module ClassMethods
+      def caller_object
+        @caller_object ||= Class.new.extend(self)
+      end
+
+      def method_missing(method_name, *args, &block)
+        if instance_methods.include?(method_name)
+          begin
+            caller_object.send(method_name, *args)
+          rescue Exception => e
+            handle_exception(e)
+          end
+        else
+          super
+        end
+      end
+
+      def handle_exception(e)
+        log_error(e)
+
+        case e
+        when ActiveRecord::RecordNotFound
+          raise RecordNotFound, e.message
+        when ActiveRecord::RecordInvalid
+          raise RecordInvalid.new("#{e.record.class.name} #{e.message}", e.record.errors)
+        when ActiveRecord::RecordNotSaved
+          raise RecordNotSaved.new("#{e.record.class.name} #{e.message}", e.record.errors)
+        when URI::BadURIError
+          raise e.message.include?('gid') ? InvalidGlobalID.new(e.message) : e
+        when URI::GID::MissingModelIdError
+          raise InvalidGlobalID, e.message
+        else
+          raise e
+        end
+      end
+
+      def log_error(e, msg = nil)
+        logger.error "[#{@namespace}] #{msg}: #{e.message}"
+      end
+
+      def logger
+        @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      end
+
+      def logger=(logger)
+        @logger = logger
+      end
+    end
+  end
+end

data/lib/nano-service/error_serializer.rb

@@ -0,0 +1,11 @@
+module NanoService
+  class ErrorSerializer
+    def self.serialize(errors)
+      if errors && errors.respond_to?(:to_hash) && errors.respond_to?(:full_messages)
+        errors.to_hash.merge(full_messages: errors.try(:full_messages))
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/nano-service/exceptions.rb

@@ -0,0 +1,25 @@
+module NanoService
+  class Error < StandardError
+  end
+
+  class InvalidRecordError < Error
+    attr_reader :errors
+
+    def initialize(msg = nil, errors = nil)
+      super(msg)
+      @errors = ErrorSerializer.serialize(errors)
+    end
+  end
+
+  class RecordNotFound < Error
+  end
+
+  class RecordInvalid < InvalidRecordError
+  end
+
+  class RecordNotSaved < InvalidRecordError
+  end
+
+  class InvalidGlobalID < Error
+  end
+end

data/lib/nano-service/version.rb

@@ -0,0 +1,3 @@
+module NanoService
+  VERSION = "0.0.1"
+end

data/nano-service.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "nano-service/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'nano-service'
+  s.version     = NanoService::VERSION
+  s.license     = "MIT"
+  s.authors     = ['Dave Riess']
+  s.email       = ['dave@wundercapital.com']
+  s.homepage    = 'https://github.com/wunderteam/nano-service'
+  s.summary     = 'A thin module wrapper for helping enforce service boundaries'
+  s.description = 'A thin module wrapper for helping enforce service boundaries'
+
+  s.required_ruby_version = '>= 2.2.0'
+  s.add_dependency 'activerecord',    "~> 4.0"
+  s.add_dependency 'activesupport',   "~> 4.0"
+  s.add_dependency 'globalid',        "~> 0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/base_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+MockService.logger = Logger.new('/dev/null')
+
+describe NanoService::Base do
+  describe 'method proxy' do
+    it 'proxies instance methods through class method_missing' do
+      allow_any_instance_of(MockService).to receive(:foo) { 'bar' }
+      expect(MockService.foo).to eq('bar')
+    end
+
+    it 'does not proxy private instance methods through class method_missing' do
+      expect { MockService.private_foo }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe 'exception handling' do
+    it 'passes exception to handle_exception' do
+      allow_any_instance_of(MockService).to receive(:exception!) { raise StandardError }
+      allow(MockService).to receive(:handle_exception) { true }
+      MockService.exception!
+
+      expect(MockService).to have_received(:handle_exception).with(StandardError)
+    end
+
+    # allows service to raise NanoService errors directly
+    describe 'NanoService exceptions' do
+      it 'catches and re-raises any NanoService exceptions' do
+        allow_any_instance_of(MockService).to receive(:exception!) do
+          raise NanoService::Error
+        end
+
+        expect { MockService.exception! }.to raise_error(NanoService::Error)
+      end
+    end
+
+    # dynamically defines NanoService errors within service namespace
+    describe 'NanoService exceptions' do
+      it 'catches and re-raises any NanoService exceptions' do
+        allow_any_instance_of(MockService).to receive(:exception!) do
+          raise MockService::Error
+        end
+
+        expect { MockService.exception! }.to raise_error(MockService::Error)
+      end
+    end
+
+    # re-packages known errors as NanoService errors
+    describe 'known exceptions' do
+      it 'catches ActiveRecord::RecordNotFound exceptions and returns RecordNotFound' do
+        allow_any_instance_of(MockService).to receive(:exception!) do
+          raise ActiveRecord::RecordNotFound
+        end
+
+        expect { MockService.exception! }.to raise_error(NanoService::RecordNotFound)
+      end
+
+      # TODO: do a better job mocking ActiveRecord errors
+      # it 'catches ActiveRecord::RecordInvalid exceptions and returns RecordInvalid' do
+      #   allow_any_instance_of(MockService).to receive(:exception!) do
+      #     raise ActiveRecord::RecordInvalid, 'foobar'
+      #   end
+      #
+      #   expect{ MockService.exception! }.to raise_error(NanoService::RecordInvalid)
+      # end
+      #
+      # it 'catches ActiveRecord::RecordNotSaved exceptions and returns RecordNotSaved' do
+      #   allow_any_instance_of(MockService).to receive(:exception!) do
+      #     raise ActiveRecord::RecordNotSaved
+      #   end
+      #
+      #   expect{ MockService.exception! }.to raise_error(NanoService::RecordNotSaved)
+      # end
+
+      it 'catches URI::BadURIError (gid) exceptions and returns InvalidGlobalID' do
+        allow_any_instance_of(MockService).to receive(:exception!) { GlobalID.new('foo') }
+
+        expect { MockService.exception! }.to raise_error(NanoService::InvalidGlobalID)
+      end
+
+      it 'catches URI::GID::MissingModelIdError exceptions and returns InvalidGlobalID' do
+        allow_any_instance_of(MockService).to receive(:exception!) { GlobalID.new('gid://foo/Bar') }
+
+        expect { MockService.exception! }.to raise_error(NanoService::InvalidGlobalID)
+      end
+    end
+
+    # re-rasies unknown errors
+    describe 'unknown exception' do
+      it 'catches StandardError and returns StandardError' do
+        allow_any_instance_of(MockService).to receive(:exception!) { raise StandardError }
+
+        expect { MockService.exception! }.to raise_error(StandardError)
+      end
+    end
+  end
+end

data/spec/error_serializer_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+class Fish
+  extend ActiveModel::Naming
+  extend ActiveModel::Translation
+  attr_accessor :name, :type
+  def errors
+    @errors ||= ActiveModel::Errors.new(self)
+  end
+end
+
+describe NanoService::ErrorSerializer do
+  subject { described_class }
+
+  let(:model) { Fish.new }
+
+  before do
+    model.errors.add(:name, 'is required')
+    model.errors.add(:type, 'is invalid')
+    model.errors.add(:type, 'must be one of (fighting,freshwater)')
+  end
+
+  describe '::serialize' do
+    it 'serializes model errors for public consumption' do
+      expect(subject.serialize(model.errors)).to eq(
+        name: ['is required'],
+        type: ['is invalid', 'must be one of (fighting,freshwater)'],
+        full_messages: [
+          'Name is required',
+          'Type is invalid',
+          'Type must be one of (fighting,freshwater)'
+        ]
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'nano-service'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))].each {|f| require f}

data/spec/support/mock_service.rb

@@ -0,0 +1,9 @@
+module MockService
+  include NanoService::Base
+
+  private
+
+  def private_foo
+    'bar'
+  end
+end

data/spec/support/mock_service/exceptions.rb

@@ -0,0 +1,4 @@
+module MockService
+  class CustomError < NanoService::Error
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: nano-service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dave Riess
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A thin module wrapper for helping enforce service boundaries
+email:
+- dave@wundercapital.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lib/nano-service.rb
+- lib/nano-service/base.rb
+- lib/nano-service/error_serializer.rb
+- lib/nano-service/exceptions.rb
+- lib/nano-service/version.rb
+- nano-service.gemspec
+- spec/base_spec.rb
+- spec/error_serializer_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_service.rb
+- spec/support/mock_service/exceptions.rb
+homepage: https://github.com/wunderteam/nano-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: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A thin module wrapper for helping enforce service boundaries
+test_files:
+- spec/base_spec.rb
+- spec/error_serializer_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_service.rb
+- spec/support/mock_service/exceptions.rb