harmony-service 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89bf205b49b089b6efc12ebdb0e91132b1ae0b27
-  data.tar.gz: 5b33365abe55dadeeff62276c044d548b545b820
+  metadata.gz: 3b38543c27255399b4d62dc894bd21a6b585d73e
+  data.tar.gz: b887efe0fd12aebe15f877964bd2d82de5460084
 SHA512:
-  metadata.gz: 595e1653de7f3f381e4f99fe5d19659de9e480f166fb31b06c07255b525dddf12536f3fe4778b0434bd1509ea78b7ae10fa3ee5b150a8566cb56539e51cd6d6d
-  data.tar.gz: cf1b3d953239ac5958afc720778534367426245cce561c8ca0efe4c271770106c90b07a0c51cdb9c9934e011b4ae65ddf626e431ec9d3a1f75c9c126ecb72ff2
+  metadata.gz: cbf739554afce68602f12c1bc07e1e2d9c9848ad7f1d19f286d2a645cf6a5486246c4df8bb4b36215991e4215a8e25eadbbfd1c4de2b32ecbf8200e79b4c25cf
+  data.tar.gz: 3eafe55ff0d0ffdf6798a6bcda38684338388fe9ef9ceb8374909674aa345028fec3c63097b68c6aa44a0ce54bb115b5102a30cad121d410efded47dfdc2bc1a

data/README.md

@@ -1,41 +1,21 @@
 # Harmony::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/harmony/service`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The Harmony Service gem simplifies creation of a Service in the Harmony Platform.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'harmony-service'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install harmony-service
+1. Create a new Service via the Harmony platform
+1. Download the code for your Service.
+1. Run `bundle install`
 
 ## Usage
 
-TODO: Write usage instructions here
+In order to test your code locally you can run `bundle exec rspec`. Once you have completed development you can upload into the Harmony Platform.
 
 ## 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/[USERNAME]/harmony-service.
-
+Your Service should respond to request messages appropriately. You can find the relevant mappings [here](https://github.com/HarmonyMobile/harmony-service/blob/master/lib/harmony/service/rpc_service.rb#L95).  
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/harmony_service

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require 'sneakers'
+require 'sneakers/runner'
+require 'harmony/service'
+
+abort("usage: harmony_service [handler class name] --require [handler class file]") unless ARGV.length == 3
+
+handler_class = ARGV[0]
+puts "Starting Harmony Service with handler: #{handler_class}"
+load File.expand_path(ARGV[2])
+
+opts = {
+  amqp: ENV['ampq_address'] || 'amqp://localhost:5672',
+  vhost: ENV['ampq_vhost'] || '/',
+  exchange: 'sneakers',
+  exchange_type: :direct,
+  metrics: Sneakers::Metrics::LoggingMetrics.new,
+  handler: Sneakers::Handlers::Maxretry,
+  handler_class: handler_class
+}
+
+Sneakers.server = true
+Sneakers.configure(opts)
+Sneakers.logger.level = ENV['log_level'] == 'debug' ? Logger::DEBUG : Logger::INFO
+
+Rollbar.configure do |config|
+  config.access_token = ENV['rollbar_access_token']
+  config.environment = ENV['RACK_ENV']
+  config.enabled = ENV['RACK_ENV'] == 'staging' || ENV['RACK_ENV'] == 'production'
+end
+
+r = Sneakers::Runner.new([Harmony::Service::RpcService])
+pid = Sneakers::CONFIG[:pid_path]
+puts "Started pid: #{pid}"
+r.run

data/harmony-service.gemspec

@@ -11,9 +11,9 @@ Gem::Specification.new do |spec|
   spec.summary       = "Gem which helps you to build Harmony services"
   spec.homepage      = "https://github.com/HarmonyMobile/harmony-service"
   spec.license       = "MIT"
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files`.split($/).reject { |f| f == 'Gemfile.lock' }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.executables   = spec.files.grep(/^bin/).map { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "sneakers", '~> 2.4'

data/lib/harmony/service/calculator/request.rb

@@ -1,3 +1,3 @@
 class Harmony::Service::Calculator::Request < Harmony::Service::Request
-  attr_accessor :inputs
+  attr_accessor :uri, :inputs, :outputs
 end

data/lib/harmony/service/flow/ended_request.rb

@@ -0,0 +1,3 @@
+class Harmony::Service::Flow::EndedRequest < Harmony::Service::Request
+  attr_accessor :pages
+end

data/lib/harmony/service/form/get_request.rb

@@ -0,0 +1,3 @@
+class Harmony::Service::Form::GetRequest < Harmony::Service::Request
+  attr_accessor :inputs
+end

data/lib/harmony/service/form/get_response.rb

@@ -0,0 +1,3 @@
+class Harmony::Service::Form::GetResponse < Harmony::Service::Request
+  attr_accessor :input_values
+end

data/lib/harmony/service/rpc_service.rb

@@ -5,29 +5,11 @@ require 'json'
 require 'oj'
 require 'rollbar'
 
-opts = {
-  amqp: ENV['ampq_address'] || 'amqp://localhost:5672',
-  vhost: ENV['ampq_vhost'] || '/',
-  exchange: 'sneakers',
-  exchange_type: :direct,
-  metrics: Sneakers::Metrics::LoggingMetrics.new,
-  handler: Sneakers::Handlers::Maxretry
-}
-
-Sneakers.configure(opts)
-Sneakers.logger.level = ENV['log_level'] == 'debug' ? Logger::DEBUG : Logger::INFO
-
-Rollbar.configure do |config|
-  config.access_token = ENV['rollbar_access_token']
-  config.environment = ENV['RACK_ENV']
-  config.enabled = ENV['RACK_ENV'] == 'staging' || ENV['RACK_ENV'] == 'production'
-end
-
 module Harmony
   module Service
     class RpcService
-  
       include Sneakers::Worker
+      from_queue ENV['harmony_queue'], timeout_job_after: 10, threads: 1
   
       def work_with_params(message, delivery_info, metadata)
         begin
@@ -35,9 +17,9 @@ module Harmony
           request = Oj.load(message)
           request_class = request.class
           response_class = request_response_mapping[request_class]
-          raise "Unacceptable request class: #{request_class}" if response_class.nil? 
+          raise "Unacceptable request class: #{request_class}" if response_class.nil?
           
-          result = work_with_request(request)
+          result = new_handler.work_with_request(request)
           raise "Unacceptable response class: #{result.class}" unless response_class === result
           
           json = Oj.dump(result)
@@ -98,9 +80,19 @@ module Harmony
           ActionList::ListRequest => Array,
           ActionList::ItemRequest => ActionList::Item,
           ActionList::ActionRequest => NilClass,
-          Chart::Request => Chart::Response
+          Chart::Request => Chart::Response,
+          Form::GetRequest => Form::GetResponse,
+          Flow::EndedRequest => Response
         }
       end
+      
+      def new_handler
+        handler_class = Sneakers::CONFIG[:handler_class]
+        raise "No handler specified" if handler_class.nil? 
+        
+        handler = Object.const_get(handler_class).new
+        raise "Unable to create handler: #{handler_class}" if handler.nil? 
+      end
     end
   end
 end

data/lib/harmony/service/version.rb

@@ -1,6 +1,6 @@
 module Harmony
   module Service
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end
 
@@ -16,3 +16,11 @@ end
 module Harmony::Service::ActionList 
   
 end
+
+module Harmony::Service::Form 
+  
+end
+
+module Harmony::Service::Flow 
+  
+end

data/lib/harmony/service.rb

@@ -16,5 +16,10 @@ require 'harmony/service/action_list/list_request'
 require 'harmony/service/action_list/item_request'
 require 'harmony/service/action_list/item'
 
+require 'harmony/service/form/get_request'
+require 'harmony/service/form/get_response'
+
+require 'harmony/service/flow/ended_request'
+
 require "harmony/service/rpc_service"
 

data/spec/harmony/rpc_service_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Harmony::Service::RpcService do
+  
+  describe "#work_with_params" do
+    let(:metadata) { instance_double("Metadata", reply_to: "harmony.trello", correlation_id: "abc123") }
+    let(:handler) { handler = double("Object") }
+      
+    context "ack!" do
+      before(:each) do
+        expect(handler).to receive(:work_with_request).with(kind_of(request.class)) { response }
+        allow(subject).to receive(:new_handler) { handler }
+        allow(subject).to receive(:send_response)
+        allow(subject).to receive(:ack!)          
+        subject.work_with_params(Oj.dump(request), {}, metadata)
+      end    
+      
+      context "calculation" do
+        let(:request) { Harmony::Service::Calculator::Request.new(harmony_user_email: "matt@futureworkshops.com", inputs: {"lat" => "51.0", "lon" => "0.1"}) }
+        let(:response) { Harmony::Service::Calculator::Response.new(outputs: {price: 50})}
+      
+        it { expect(subject).to have_received(:send_response).with("{\"^o\":\"Harmony::Service::Calculator::Response\",\"outputs\":{\":price\":50}}", "harmony.trello", "abc123") }
+        it { expect(subject).to have_received(:ack!) }
+      end
+      
+      context "action list" do
+        context "list" do
+          let(:request) { Harmony::Service::ActionList::ListRequest.new(harmony_user_email: "matt@futureworkshops.com", page: 0, per_page: 10) }
+          let(:response) { [Harmony::Service::ActionList::Item.new({id: 1, title: "Carrots"})]}
+      
+          it { expect(subject).to have_received(:send_response).with("[{\"^o\":\"Harmony::Service::ActionList::Item\",\"id\":1,\"title\":\"Carrots\"}]", "harmony.trello", "abc123") }
+          it { expect(subject).to have_received(:ack!) }
+        end
+        
+        context "item" do
+          let(:request) { Harmony::Service::ActionList::ItemRequest.new(harmony_user_email: "matt@futureworkshops.com", id: 1) }
+          let(:response) { Harmony::Service::ActionList::Item.new({id: 1, title: "Carrots", subtitle: "Bag of Carrots", detail_html: "<html><body>Carrots</body></html>"})}
+      
+          it { expect(subject).to have_received(:send_response).with("{\"^o\":\"Harmony::Service::ActionList::Item\",\"id\":1,\"title\":\"Carrots\",\"subtitle\":\"Bag of Carrots\",\"detail_html\":\"<html><body>Carrots</body></html>\"}", "harmony.trello", "abc123") }
+          it { expect(subject).to have_received(:ack!) }
+        end
+        
+        context "action" do
+          let(:request) { Harmony::Service::ActionList::ActionRequest.new(harmony_user_email: "matt@futureworkshops.com", id: 1, action: "Done") }
+          let(:response) { nil }
+      
+          it { expect(subject).to have_received(:send_response).with("null", "harmony.trello", "abc123") }
+          it { expect(subject).to have_received(:ack!) }
+        end
+      end
+      
+      context "chart" do
+        let(:request) { Harmony::Service::Chart::Request.new(harmony_user_email: "matt@futureworkshops.com") }
+        let(:response) { Harmony::Service::Chart::Response.new(x_values: ["Jan", "Feb", "Mar"], y_values: [10, 20, 40])}
+        it { expect(subject).to have_received(:send_response).with("{\"^o\":\"Harmony::Service::Chart::Response\",\"x_values\":[\"Jan\",\"Feb\",\"Mar\"],\"y_values\":[10,20,40]}", "harmony.trello", "abc123") }
+        it { expect(subject).to have_received(:ack!) }
+      end
+      
+      context "form" do
+        context 'get' do
+          let(:request) { Harmony::Service::Form::GetRequest.new(harmony_user_email: "matt@futureworkshops.com", inputs: ['satisfaction_level']) }
+          let(:response) { Harmony::Service::Form::GetResponse.new({input_values: [{'satisfaction_level': ['1','2','3']}]})}
+          it { expect(subject).to have_received(:send_response).with("{\"^o\":\"Harmony::Service::Form::GetResponse\",\"input_values\":[{\":satisfaction_level\":[\"1\",\"2\",\"3\"]}],\"options\":{}}", "harmony.trello", "abc123") }
+          it { expect(subject).to have_received(:ack!) }
+        end
+      end
+      
+      context "flow ended" do
+        let(:request) { Harmony::Service::Flow::EndedRequest.new(harmony_user_email: "matt@futureworkshops.com", pages: [{page_id: 1}]) }
+        let(:response) { Harmony::Service::Response.new}
+        it { expect(subject).to have_received(:send_response).with("{\"^o\":\"Harmony::Service::Response\"}", "harmony.trello", "abc123") }
+        it { expect(subject).to have_received(:ack!) }
+      end
+      
+    end    
+  
+    context "unacceptable request class" do
+      before(:each) do
+        allow(subject).to receive(:work_with_request).and_raise("A timeout occured")
+        allow(subject).to receive(:send_response)
+        allow(subject).to receive(:reject!)
+            
+        metadata = instance_double("Metadata", reply_to: "harmony.trello", correlation_id: "abc123")
+        subject.work_with_params("{\"trello_board_id\": \"12345\"}", {}, metadata)
+      end
+    
+      it { expect(subject).to have_received(:send_response).with("{\"^o\":\"Harmony::Service::ErrorResponse\",\"message\":\"An error occured.\",\"detailed_message\":\"Unacceptable request class: Hash\"}", "harmony.trello", "abc123") }
+      it { expect(subject).to have_received(:reject!) }
+    end
+  end
+  
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'harmony/service'
+require 'byebug'
+
+opts = {
+  amqp: 'amqp://localhost:5672',
+  vhost: '/',
+  exchange: 'sneakers',
+  exchange_type: :direct,
+  metrics: Sneakers::Metrics::LoggingMetrics.new,
+  handler: Sneakers::Handlers::Maxretry
+}
+
+Sneakers.configure(opts)
+Sneakers.logger.level = Logger::DEBUG

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harmony-service
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-12-24 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sneakers
@@ -111,7 +111,8 @@ dependencies:
 description: 
 email:
 - matt@futureworkshops.com
-executables: []
+executables:
+- harmony_service
 extensions: []
 extra_rdoc_files: []
 files:
@@ -124,8 +125,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- bin/harmony_service
 - harmony-service.gemspec
 - lib/harmony/service.rb
 - lib/harmony/service/action_list/action_request.rb
@@ -137,11 +137,16 @@ files:
 - lib/harmony/service/chart/request.rb
 - lib/harmony/service/chart/response.rb
 - lib/harmony/service/error_response.rb
+- lib/harmony/service/flow/ended_request.rb
+- lib/harmony/service/form/get_request.rb
+- lib/harmony/service/form/get_response.rb
 - lib/harmony/service/message.rb
 - lib/harmony/service/request.rb
 - lib/harmony/service/response.rb
 - lib/harmony/service/rpc_service.rb
 - lib/harmony/service/version.rb
+- spec/harmony/rpc_service_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/HarmonyMobile/harmony-service
 licenses:
 - MIT
@@ -166,4 +171,6 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Gem which helps you to build Harmony services
-test_files: []
+test_files:
+- spec/harmony/rpc_service_spec.rb
+- spec/spec_helper.rb

data/bin/console

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

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here