adam_signals 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4292649941f95e37f44cd91518c6d6d3bc57d04
+  data.tar.gz: 11ef21b4b0b7695f4f919c8f5ab2690ea29db5a8
+SHA512:
+  metadata.gz: ce499d494862a08bf1e1361a481562a426450f73161f4a8e928a4c6f5e11bb3078a8d84fcabf99cfa5d6a5a59a2bd074e14247580d686dc26b7f2b12fba85425
+  data.tar.gz: df786fe591f5e164583512c41f8d57965e1891f6cdd297530dd7fae28e205705c481b533bae2774954a22147d4516dffbc63cb500d8af7ba3c677fce82ce8ff7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/ruby

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--tty
+--format documentation

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# [develop](https://github.com/mojolingo/adam_signals)
+
+# [1.0.0](https://github.com/mojolingo/adam_signals/compare/c05b045f041eb8e0364e8348e9e6fc868462cf40...v1.0.0) - [2013-11-12](https://rubygems.org/gems/adam_signals/versions/1.0.0)
+  * Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2013 Mojo Lingo LLC
+
+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,44 @@
+[![Gem Version](https://badge.fury.io/rb/adam_signals.png)](https://rubygems.org/gems/adam_signals)
+[![Build Status](https://secure.travis-ci.org/mojolingo/adam_signals.png?branch=develop)](http://travis-ci.org/mojolingo/adam_signals)
+[![Dependency Status](https://gemnasium.com/mojolingo/adam_signals.png?travis)](https://gemnasium.com/mojolingo/adam_signals)
+[![Code Climate](https://codeclimate.com/github/mojolingo/adam_signals.png)](https://codeclimate.com/github/mojolingo/adam_signals)
+[![Coverage Status](https://coveralls.io/repos/mojolingo/adam_signals/badge.png?branch=develop)](https://coveralls.io/r/mojolingo/adam_signals)
+
+# AdamSignals
+
+Common message formats exchanged between Adam Snark Rabbit organs. You can use this gem to help you implement components which interface with Adam.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'adam_signals'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adam_signals
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Links:
+* [Source](https://github.com/mojolingo/adam_signals)
+* [Documentation](http://rdoc.info/gems/adam_signals/frames)
+* [Bug Tracker](https://github.com/mojolingo/adam_signals/issues)
+* [CI](https://travis-ci.org/#!/mojolingo/adam_signals)
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright (c) 2013 Mojo Lingo LLC. MIT licence (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+
+require 'bundler'
+Bundler.setup
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--color'
+end

data/adam_signals.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/adam_signals/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "adam_signals"
+  gem.authors       = ["Ben Langfeld"]
+  gem.email         = ["ben@langfeld.me"]
+  gem.description   = %q{Common message formats exchanged between Adam Snark Rabbit organs}
+  gem.summary       = %q{Adam Snark Rabbit shared message formats}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  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.version       = AdamSignals::VERSION
+
+  gem.add_runtime_dependency 'virtus', '~> 1.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'coveralls'
+end

data/lib/adam_signals.rb

@@ -0,0 +1,6 @@
+require "adam_signals/version"
+require "adam_signals/message"
+require "adam_signals/response"
+
+module AdamSignals
+end

data/lib/adam_signals/message.rb

@@ -0,0 +1,26 @@
+require 'json'
+require 'virtus'
+
+class AdamSignals::Message
+  include Virtus.value_object
+
+  values do
+    attribute :source_type, Symbol
+    attribute :source_address, String
+    attribute :auth_address, String
+    attribute :body, String
+    attribute :user, Hash
+  end
+
+  def self.from_json(json)
+    new JSON.parse(json)
+  end
+
+  def to_json
+    JSON.generate attributes
+  end
+
+  def to_s
+    "#<#{self.class.name} #{attributes}>"
+  end
+end

data/lib/adam_signals/response.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'virtus'
+
+class AdamSignals::Response
+  include Virtus.value_object
+
+  values do
+    attribute :target_type, Symbol
+    attribute :target_address, String
+    attribute :body, String
+  end
+
+  def self.from_json(json)
+    new JSON.parse(json)
+  end
+
+  def to_json
+    JSON.generate attributes
+  end
+
+  def to_s
+    "#<#{self.class.name} #{attributes}>"
+  end
+end

data/lib/adam_signals/version.rb

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

data/spec/adam_signals/message_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe AdamSignals::Message do
+  let(:source_type)     { :xmpp }
+  let(:source_address)  { 'foo@bar.com' }
+  let(:auth_address)    { 'doo@dah.com' }
+  let(:body)            { 'Hello there' }
+  let(:user)            { { 'profile' => {'name' => 'Ben Langfeld'} } }
+
+  subject { described_class.new source_type: source_type, source_address: source_address, auth_address: auth_address, body: body, user: user }
+
+  its(:source_type)     { should == source_type }
+  its(:source_address)  { should == source_address }
+  its(:auth_address)    { should == auth_address }
+  its(:body)            { should == body }
+  its(:user)            { should == { 'profile' => {'name' => 'Ben Langfeld'} } }
+
+  it "should be able to encode to and decode from JSON" do
+    subject.should eql(described_class.from_json(subject.to_json))
+  end
+
+  describe "equality" do
+    context "with no attributes set" do
+      it "should be equal" do
+        described_class.new.should eql(described_class.new)
+      end
+    end
+
+    context "with attributes set the same" do
+      it "should be equal" do
+        described_class.new(source_type: :xmpp).should eql(described_class.new(source_type: :xmpp))
+      end
+    end
+
+    context "with attributes set differently" do
+      it "should be equal" do
+        described_class.new(source_type: :email).should_not eql(described_class.new(source_type: :xmpp))
+      end
+    end
+  end
+end

data/spec/adam_signals/response_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe AdamSignals::Response do
+  let(:target_type)     { :xmpp }
+  let(:target_address)  { 'foo@bar.com' }
+  let(:body)            { 'Hello there' }
+
+  subject { described_class.new target_type: target_type, target_address: target_address, body: body }
+
+  its(:target_type)     { should == target_type }
+  its(:target_address)  { should == target_address }
+  its(:body)            { should == body }
+
+  it "should be able to encode to and decode from JSON" do
+    subject.should eql(described_class.from_json(subject.to_json))
+  end
+
+  describe "equality" do
+    context "with no attributes set" do
+      it "should be equal" do
+        described_class.new.should eql(described_class.new)
+      end
+    end
+
+    context "with attributes set the same" do
+      it "should be equal" do
+        described_class.new(target_type: :xmpp).should eql(described_class.new(target_type: :xmpp))
+      end
+    end
+
+    context "with attributes set differently" do
+      it "should be equal" do
+        described_class.new(target_type: :email).should_not eql(described_class.new(target_type: :xmpp))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'adam_signals'
+
+require 'coveralls'
+Coveralls.wear!
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: adam_signals
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Langfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Common message formats exchanged between Adam Snark Rabbit organs
+email:
+- ben@langfeld.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- adam_signals.gemspec
+- lib/adam_signals.rb
+- lib/adam_signals/message.rb
+- lib/adam_signals/response.rb
+- lib/adam_signals/version.rb
+- spec/adam_signals/message_spec.rb
+- spec/adam_signals/response_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Adam Snark Rabbit shared message formats
+test_files:
+- spec/adam_signals/message_spec.rb
+- spec/adam_signals/response_spec.rb
+- spec/spec_helper.rb