hc-service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae92c9d8cf0bfc66161c4dcb308e25c381a0058b60c1999589c3408fcd4a3ef4
+  data.tar.gz: bd9454567992da45f6028fef9ec84893ac1ede4d87fde86864b1bc6af132d402
+SHA512:
+  metadata.gz: 2cbf8229515832284bf0bccc10ca8d22e126dc7cc99f5b24a65b14636afd0649eee675cc7ac689dc6dacc0d139f766f7c1ad326487e18f796e6f2c76eb6b2016
+  data.tar.gz: d196996dcdf80423f7b6db30f38e43e9c39edb891c3b7b4363ac12a8e71c9bf90031732aab7f2cc2c12ae9ef9d1dfc2e3b8e87ae67079731166f4d51c1198c77

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Hockey Community
+
+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,39 @@
+# HC::Service
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hc/service`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hc-service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hc-service
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hc-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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hc/service/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hc-service"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Jack Hayter"]
+  spec.email         = ["jack@hockey-community.com"]
+
+  spec.summary       = "A super simple object serializer"
+  spec.description   = "Transforms objects and collections into hashes for rendering as JSON"
+  spec.homepage      = "https://github.com/HockeyCommunity/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"
+end

data/lib/hc/service.rb

@@ -0,0 +1,8 @@
+require "hc/service/base"
+require "hc/service/version"
+
+module HC
+  module Service
+
+  end
+end

data/lib/hc/service/base.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module HC
+  module Service
+
+    # Used for abstraction and clarity of service objects
+    #
+    class Base
+
+      include ActiveModel::Validations
+      include ActiveModel::Callbacks
+
+      attr_accessor :result, :manual_status_code
+
+      # Set instance variables based on arg smearing
+      #
+      def initialize(args)
+        args.each do |k, v|
+          instance_variable_set("@#{k}", v)
+        end
+      end
+
+      # Abstraction for getting a stable service code
+      #
+      def status_code
+        return manual_status_code if manual_status_code
+        return 422 if errors.present?
+        return 200 if result
+        return 0
+      end
+
+      def raise_error!(field:, message:, code: 0)
+        errors.add(field, message)
+        self.manual_status_code = code
+        raise ActiveRecord::Rollback
+      end
+
+      def raise_errors!(child_errors)
+        Array.wrap(child_errors).each do |error|
+          error.messages.each_key do |field|
+            error.messages[field].each do |message|
+              errors.add(field, message)
+            end
+          end
+        end
+        raise ActiveRecord::Rollback
+      end
+
+      def unauthorized!
+        errors.add(:user, 'Unauthorized')
+        self.manual_status_code = 401
+        raise ActiveRecord::Rollback
+      end
+
+      def present(object, method: nil, options: {})
+        HC::Presentation.present(object, method: method, options: options)
+      end
+
+      def errors?
+        errors.count.positive?
+      end
+
+      def enqueue_job(job_class:, params:, current_user:)
+        HC::Jobs.enqueue(job_class: job_class, user: current_user, params: params)
+      end
+
+      # Abstracted execution instanciates class, sets variables, runs validations, and handles errors
+      #
+      def self.execute(args)
+
+        # Build the new service
+        #
+        service = new(args)
+
+        # Service executions should be wrapped in a transaction, and gracefully handle errors
+        #
+        ActiveRecord::Base.transaction do
+
+          # Validate service args
+          #
+          service.try(:before_validation)
+          return service unless service.valid?
+
+          # Attempt execution of service
+          #
+          begin
+            service.execute
+          rescue ActiveRecord::RecordInvalid => ex
+            if service.errors.blank?
+              service.errors.add(:validation, ex.record.errors)
+              service.manual_status_code = 422
+            end
+            raise ActiveRecord::Rollback
+          rescue ActiveRecord::Rollback => ex
+            raise ex
+          rescue StandardError => ex
+            Rails.logger.debug '================================='
+            Rails.logger.debug ex.inspect
+            Rails.logger.debug ex.backtrace.join("\n")
+            Rails.logger.debug '================================='
+            if service.errors.blank?
+              service.errors.add(:exception, 'An error occurred')
+              service.manual_status_code = 500
+            end
+            raise ActiveRecord::Rollback
+          end
+        end
+        return service
+
+      end
+
+    end
+
+  end
+end

data/lib/hc/service/version.rb

@@ -0,0 +1,5 @@
+module HC
+  module Service
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: hc-service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Hayter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+description: Transforms objects and collections into hashes for rendering as JSON
+email:
+- jack@hockey-community.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hc-service.gemspec
+- lib/hc/service.rb
+- lib/hc/service/base.rb
+- lib/hc/service/version.rb
+homepage: https://github.com/HockeyCommunity/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.3
+signing_key: 
+specification_version: 4
+summary: A super simple object serializer
+test_files: []