roqua-rom-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bde7b277fe62ad02a254c9b2178396c604d84a59
+  data.tar.gz: 2837225a0fa190fa140be2c54b40fd7a8c527f5d
+SHA512:
+  metadata.gz: a86a5bce3202da7c8f33303469ed2d1d0f5d5972284adff5c260c746a2517816182243a853c4589e5d72d49e4442bba313d3d9e75c68d7c0d5cb639f63aa3ff6
+  data.tar.gz: 8114eae0d7166e741dedd0d6ae86ce260bc5bec8ab154af2f7011aa4500d47f623db2aeb253b95a16e788f1508e884263211507fcc435ee38b245afdd8b56d9e

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'guard-rspec', '~> 4.2.6'
+  gem 'fuubar',      '~> 1.3.2'
+end

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    roqua-rom-api (0.0.1)
+      active_interaction (~> 1.0.4)
+      httparty (~> 0.12.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_interaction (1.0.4)
+      activemodel (>= 3, < 5)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    builder (3.1.4)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    celluloid-io (0.15.0)
+      celluloid (>= 0.15.0)
+      nio4r (>= 0.5.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    fuubar (1.3.2)
+      rspec (>= 2.14.0, < 3.1.0)
+      ruby-progressbar (~> 1.3)
+    guard (2.4.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.6)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.9)
+    json (1.8.1)
+    listen (2.5.0)
+      celluloid (>= 0.15.2)
+      celluloid-io (>= 0.15.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    multi_xml (0.5.5)
+    nio4r (1.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    ruby-progressbar (1.4.1)
+    slop (3.4.7)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    timers (1.1.0)
+    tzinfo (0.3.38)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  fuubar (~> 1.3.2)
+  guard-rspec (~> 4.2.6)
+  rake (~> 10.1)
+  roqua-rom-api!
+  yard (~> 0.8)

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec --format Fuubar --colour' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Samuel Esposito
+
+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,18 @@
+# roqua-rom-api
+
+Description goes here.
+
+## Contributing to roqua-rom-api
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Samuel Esposito. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit(-1)
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+task test: :spec
+task default: :spec
+
+require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task doc: :yard

data/lib/roqua/rom_api/base.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+
+module Roqua
+  module RomApi
+    class Base
+      def self.get(url, params = {})
+        # TODO: Handle http basic authentication here
+        HTTParty.get(api_base + url + '.json', query: params, basic_auth: authentication)
+      end
+
+      def self.post(url, params = {})
+        # TODO: Handle http basic authentication here
+        HTTParty.post(api_base + url + '.json', query: params, basic_auth: authentication)
+      end
+
+      def self.put(url, params = {})
+        # TODO: Handle http basic authentication here
+        HTTParty.put(api_base + url + '.json', query: params, basic_auth: authentication)
+      end
+
+      def self.delete(url, params = {})
+        # TODO: Handle http basic authentication here
+        HTTParty.delete(api_base + url + '.json', query: params, basic_auth: authentication)
+      end
+
+      private
+
+      def self.rom_host
+        @roqua_rom_host || ENV['ROQUA_ROM_HOST']
+      end
+
+      def self.username
+        @roqua_rom_key || ENV['ROQUA_ROM_KEY']
+      end
+
+      def self.password
+        @roqua_rom_secret || ENV['ROQUA_ROM_SECRET']
+      end
+
+      def self.authentication
+        {username: username, password: password}
+      end
+
+      def self.api_path
+        '/api/v1'
+      end
+
+      def self.api_base
+        rom_host + api_path
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/start_protocol_subscription.rb

@@ -0,0 +1,17 @@
+module Roqua
+  module RomApi
+    class StartProtocolSubscription < ActiveInteraction::Base
+      string :dossier_id
+      string :protocol_key
+      time :start_at, default: nil
+      integer :daily_start_time, default: nil
+
+      def execute
+        Base.post '/protocol_subscriptions', dossier_id: dossier_id,
+                                             protocol_key: protocol_key,
+                                             start_at: (start_at.to_i if start_at),
+                                             daily_start_time: daily_start_time
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/version.rb

@@ -0,0 +1,5 @@
+module Roqua
+  module RomApi
+    VERSION = "0.0.1"
+  end
+end

data/lib/roqua/rom_api.rb

@@ -0,0 +1,4 @@
+require 'roqua/rom_api/version'
+require 'active_interaction'
+require 'roqua/rom_api/base'
+require 'roqua/rom_api/start_protocol_subscription'

data/lib/roqua-rom-api.rb

@@ -0,0 +1 @@
+require 'roqua/rom_api'

data/roqua_rom_api.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require File.expand_path('../lib/roqua/rom_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "roqua-rom-api"
+  gem.version       = Roqua::RomApi::VERSION
+  gem.summary       = %q{API wrapper gem around RoQua's ROM API}
+  gem.description   = %q{Provides authenticated access to ROM utilities}
+  gem.license       = "MIT"
+  gem.authors       = ["Samuel Esposito"]
+  gem.email         = "s.esposito@roqua.nl"
+  gem.homepage      = "https://github.com/roqua/rom/blob/master/rom_api/README.md"
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'httparty',           '~> 0.12.0'
+  gem.add_dependency 'active_interaction', '~>  1.0.4'
+
+  gem.add_development_dependency 'bundler', '~>  1.0'
+  gem.add_development_dependency 'rake',    '~> 10.1'
+  gem.add_development_dependency 'yard',    '~>  0.8'
+end

data/spec/lib/roqua/rom_api/base_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Roqua
+  describe RomApi::Base do
+    let(:url)    { '/some/url' }
+    let(:params) { {some: 'params'} }
+    before do
+      RomApi::Base.instance_eval do
+        @roqua_rom_host = 'http://roqua.dev'
+        @roqua_rom_key = 'uname'
+        @roqua_rom_secret = 'pwd'
+      end
+    end
+
+    describe '.get' do
+      it 'performs a get request to a rom_api passing in some parameters' do
+        expect(HTTParty).to receive(:get).with('http://roqua.dev/api/v1/some/url.json',
+                                               query: params,
+                                               basic_auth: {username: 'uname', password: 'pwd'})
+        RomApi::Base.get(url, params)
+      end
+    end
+
+    describe '.post' do
+      it 'performs a get request to a rom_api passing in some parameters' do
+        expect(HTTParty).to receive(:post).with('http://roqua.dev/api/v1/some/url.json',
+                                                query: params,
+                                                basic_auth: {username: 'uname', password: 'pwd'})
+        RomApi::Base.post(url, params)
+      end
+    end
+
+    describe '.put' do
+      it 'performs a get request to a rom_api passing in some parameters' do
+        expect(HTTParty).to receive(:put).with('http://roqua.dev/api/v1/some/url.json',
+                                               query: params,
+                                               basic_auth: {username: 'uname', password: 'pwd'})
+        RomApi::Base.put(url, params)
+      end
+    end
+
+    describe '.delete' do
+      it 'performs a get request to a rom_api passing in some parameters' do
+        expect(HTTParty).to receive(:delete).with('http://roqua.dev/api/v1/some/url.json',
+                                                  query: params,
+                                                  basic_auth: {username: 'uname', password: 'pwd'})
+        RomApi::Base.delete(url, params)
+      end
+    end
+  end
+end

data/spec/lib/roqua/rom_api/start_protocol_subscription_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe StartProtocolSubscription do
+  it 'does a post to the rom protocol_subscription api' do
+    options = {dossier_id: 'some_dossier_id',
+               protocol_key: 'some_key',
+               start_at: Time.now,
+               daily_start_time: 32400}       # nine o'clock
+    expect(Base).to receive(:post).with '/protocol_subscriptions', dossier_id: options[:dossier_id],
+                                                                   protocol_key: options[:protocol_key],
+                                                                   start_at: options[:start_at].to_i,
+                                                                   daily_start_time: options[:daily_start_time]
+    StartProtocolSubscription.run(options)
+  end
+end

data/spec/lib/roqua_rom_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Roqua::RomApi do
+  it "should have a VERSION constant" do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'roqua-rom-api'
+include Roqua::RomApi

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: roqua-rom-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Samuel Esposito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: active_interaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Provides authenticated access to ROM utilities
+email: s.esposito@roqua.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/roqua-rom-api.rb
+- lib/roqua/rom_api.rb
+- lib/roqua/rom_api/base.rb
+- lib/roqua/rom_api/start_protocol_subscription.rb
+- lib/roqua/rom_api/version.rb
+- roqua_rom_api.gemspec
+- spec/lib/roqua/rom_api/base_spec.rb
+- spec/lib/roqua/rom_api/start_protocol_subscription_spec.rb
+- spec/lib/roqua_rom_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/roqua/rom/blob/master/rom_api/README.md
+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.2.1
+signing_key: 
+specification_version: 4
+summary: API wrapper gem around RoQua's ROM API
+test_files:
+- spec/lib/roqua/rom_api/base_spec.rb
+- spec/lib/roqua/rom_api/start_protocol_subscription_spec.rb
+- spec/lib/roqua_rom_api_spec.rb
+- spec/spec_helper.rb
+has_rdoc: