use_case_pattern 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a796de4be01c7ff1d29ac4b4a5be9cf14509f647
+  data.tar.gz: 95cbe71afd5dda0f93b6d537e2bbb782fbcab41a
+SHA512:
+  metadata.gz: 4878b19038885f4654482ec655aaf340d931edb8a98d9ac280f7830adff2987c8f846981baaca2651b2e1db3121fadada88641ea19b46b02ab8f631877ef0978
+  data.tar.gz: f1e7b6b0ba605777cca19d621f89345aee70bf4135738b0ba2c7b28cba97b96a4d2021e0e843a40c557e61653110995cf3024b9581e2f1d2fbbcdbf0fc7fa499

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,74 @@
+# UseCasePattern
+
+A module that helps you to implement the Use Case design pattern.
+
+This pattern is widely used by the teams at Abletech. We were first introduced to this pattern by Shevaun Coker at RubyConf AU 2015 in Melbourne, Australia. You can read more about this pattern in her blog post A [Case for Use Cases](http://webuild.envato.com/blog/a-case-for-use-cases/), and also in the [video of the presentation](https://rubyconf.eventer.com/rubyconf-australia-2015-1223/a-case-for-use-cases-by-shevaun-coker-1734) that she gave. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'use_case_pattern'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install use_case_pattern
+
+## Basic Usage
+
+When you follow the use case design pattern, you normally define a class with a constructor, and a perform method. You should include the `UseCasePattern` module. Here is a simple example:
+
+```ruby 
+class NumberMultiplier
+  include UseCasePattern
+
+  attr_reader :product
+  
+  validates :number1, :number2, presence: true
+
+  def initialize(number1, number2)
+    @number1 = number1
+    @number2 = number2
+  end
+  
+  def perform
+    if valid?
+      @product = number1 * number2
+    end
+  end
+  
+  private
+  
+  attr_reader :number1, :number2
+end
+```
+
+You could call this simple example from a Rails Controller, or anywhere else really. Here is an example:
+
+```ruby
+  def multiply
+    multiplier = NumberMultiplier.perform(params[:number1], params[:number2])
+    
+    if multiplier.success?
+      @result = multiplier.result
+    else
+      redirect_to :new, notice: multiplier.errors.full_messages
+    end
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/abletech/use_case_pattern.

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 "use_case_pattern"
+
+# 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/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/examples/export_to_redis.rb

@@ -0,0 +1,31 @@
+class ExportToRedis
+  include UseCasePattern
+
+  validates :hit, presence: true
+
+  def initialize(hit:)
+    @hit = hit
+  end
+
+  def perform
+    redis.lpush("usage_hits", serialised_hit)
+    disconnect_redis
+  end
+
+  private
+
+  attr_reader :hit
+
+  def redis
+    @redis ||= Redis.new(host: "127.0.0.1", port: 6379)
+  end
+
+  def disconnect_redis
+    redis.quit
+    @redis = nil
+  end
+
+  def serialised_hit
+    JSON.generate(hit.attributes)
+  end
+end

data/examples/harvest.rb

@@ -0,0 +1,67 @@
+require 'nokogiri'
+
+class Harvest
+  include UseCasePattern
+
+  def initialize(station_id:)
+    @station_id = station_id.to_i
+  end
+
+  def perform
+    run_query
+    parse_response
+  end
+
+  attr_reader :temperature, :wind_speed, :wind_direction, :wind_gust, :wind_compass, :recorded_at
+
+  private
+
+  def parse_response
+    document = Nokogiri::HTML(@response_body)
+
+    @temperature = document.css('#temp').first.content.strip[0..-3]
+    @wind_speed = document.css('#windspd').first.content.strip.match(/[\d\.]+/)
+    @wind_direction = document.css('#windspd').first.content.strip.match(/Wind\s([NESW]+)\s.*/)[1]
+    @wind_gust = document.css('#windgust').first.content.strip.match(/Gust\s([\d\.]+)km\/h/)[1]
+    @recorded_at = Time.strptime(document.css('#title').first.content.strip, 'Weather at %H:%M %a %e %b %Y')
+    @wind_compass = case @wind_direction
+    when 'N' then 0
+    when 'NNE' then 23
+    when 'NE' then 45
+    when 'ENE' then 68
+    when 'E' then 90
+    when 'ESE' then 113
+    when 'SE' then 135
+    when 'SSE' then 158
+    when 'S' then 180
+    when 'SSW' then 203
+    when 'SW' then 225
+    when 'WSW' then 248
+    when 'W' then 270
+    when 'WNW' then 293
+    when 'NW' then 315
+    when 'NNW' then 338
+    end
+  end
+
+  def host
+    'harvestelectronics.com'
+  end
+
+  def query_string
+    "/w.cgi?hsn=#{@station_id}&cmd=cwc"
+  end
+
+  def run_query
+    http = Net::HTTP.new(host)
+    response = http.request(Net::HTTP::Get.new(query_string))
+
+    if response.code != "200"
+      $stderr.puts "Harvest error (status-code: #{response.code})\n#{response.body}"
+
+      @response_body = nil
+    else
+      @response_body = response.body
+    end
+  end
+end

data/examples/thing_speak_reporter.rb

@@ -0,0 +1,32 @@
+class ThingSpeakReporter
+  include UseCasePattern
+
+  def initialize(api_key:, params: {})
+    @api_key = api_key
+    @params = params
+  end
+
+  def perform
+    post_data
+    check_response
+  end
+
+  private
+
+  attr_reader :params, :api_key, :response
+
+  def post_data
+    uri = URI("https://api.thingspeak.com/update.json")
+    @response = Net::HTTP.post_form(uri, request_params)
+  end
+
+  def check_response
+    if response.code != '200'
+      errors.add(:base, "Non 200 response #{response.code}: #{response.body}")
+    end
+  end
+
+  def request_params
+    params.merge(api_key: api_key)
+  end
+end

data/lib/use_case_pattern/base.rb

@@ -0,0 +1,44 @@
+require "active_support"
+require "active_model"
+
+module UseCasePattern
+  module Base
+    extend ActiveSupport::Concern
+    include ActiveModel::Validations
+
+    module ClassMethods
+      # The perform method of a UseCase should always return itself
+      def perform(*args)
+        new(*args).tap { |use_case| use_case.perform }
+      end
+
+      # Raise an exception if perform generates any errors
+      def perform!(*args)
+        new(*args).tap { |use_case| use_case.perform! }
+      end
+    end
+
+    # Implement all the steps required to complete this use case
+    def perform
+      raise NotImplementedError
+    end
+
+    def perform!
+      perform
+
+      if failure?
+        raise_validation_error
+      end
+    end
+
+    # Has this use case performed its task successfully?
+    def success?
+      errors.none?
+    end
+
+    # Did this use case have any errors?
+    def failure?
+      errors.any?
+    end
+  end
+end

data/lib/use_case_pattern/version.rb

@@ -0,0 +1,3 @@
+module UseCasePattern
+  VERSION = "1.0.0"
+end

data/lib/use_case_pattern.rb

@@ -0,0 +1,8 @@
+require "use_case_pattern/version"
+require "use_case_pattern/base"
+
+module UseCasePattern
+  def self.included(receiver)
+    receiver.send :include, UseCasePattern::Base
+  end
+end

data/use_case_pattern.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'use_case_pattern/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "use_case_pattern"
+  spec.version       = UseCasePattern::VERSION
+  spec.authors       = ["Nigel Ramsay"]
+  spec.email         = ["nigel@abletech.nz"]
+
+  spec.summary       = "A module that helps you to implement the Use Case design pattern"
+  spec.description   = "A module that helps you to implement the Use Case design pattern"
+  spec.homepage      = "https://github.com/abletech/use_case_pattern"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_runtime_dependency "activemodel", [">= 4.0.0", "~> 5.0.0"]
+  spec.add_runtime_dependency "activesupport", [">= 4.0.0", "~> 5.0.0"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: use_case_pattern
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nigel Ramsay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: A module that helps you to implement the Use Case design pattern
+email:
+- nigel@abletech.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/export_to_redis.rb
+- examples/harvest.rb
+- examples/thing_speak_reporter.rb
+- lib/use_case_pattern.rb
+- lib/use_case_pattern/base.rb
+- lib/use_case_pattern/version.rb
+- use_case_pattern.gemspec
+homepage: https://github.com/abletech/use_case_pattern
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A module that helps you to implement the Use Case design pattern
+test_files: []