protobuf_spec 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 66bbc89abe97ac54c85205b4dd0807626e5d674c
+  data.tar.gz: 8230b7bf3c4ed051b868ce5600fb96623c1da194
+SHA512: 
+  metadata.gz: 3fa242e56478eb0881c37abf269b709e967f0d23e1d502603bfb4d729271ad5539c16d808a25d9b04cb50ada9a2640d4b7cfbb38d529b2df75aba2c5b89261b9
+  data.tar.gz: 973b1c68787c23b251886f691b9a9801cee3245050636fb98b7ee3fc055493de40b6fcb12dbc46628be996ebb412eb906faaaad904acef60f742e209bd80da83

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 1.9.2
+- 1.9.3
+- 2.0.0

data/CONTRIBUTION_GUIDELINES.md

@@ -0,0 +1,22 @@
+If you come across any issues, please [tell us](https://github.com/connamara/protobuf_spec/issues).
+Pull requests (with tests) are appreciated. No pull request is too small. Please help with:
+
+* Reporting bugs
+* Suggesting features
+* Writing or improving documentation
+* Fixing typos
+* Cleaning whitespace
+* Refactoring code
+* Adding tests
+* Closing [issues](https://github.com/connamara/protobuf_spec/issues)
+
+Contributing to protobuf\_spec:
+
+1. Fork the [official repository](https://github.com/connamara/protobuf_spec/tree/master).
+2. Make your changes in a topic branch.
+3. Send a pull request.
+
+Notes:
+* If you report a bug and don't include a fix, please include a failing test.
+* Contributions without tests won't be accepted.
+* Please don't update the Gem version

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "ruby_protobuf", "~> 0.4.11"
+gem "json_spec", "~> 1.1.1"
+gem "cuke_mem", "~> 0.1.1"
+
+
+group :development do
+  gem "rspec", "~> 2.14"
+  gem "jeweler", "~> 1.8"
+  gem "cucumber", "~> 1.3"
+  gem "rake", "~> 10.1"
+end

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    cucumber (1.3.6)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (>= 0.0.2)
+    cuke_mem (0.1.1)
+      cucumber (~> 1.3)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    gherkin (2.12.1)
+      multi_json (~> 1.3)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    json_spec (1.1.1)
+      multi_json (~> 1.0)
+      rspec (~> 2.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.9)
+    multi_test (0.0.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    ruby_protobuf (0.4.11)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber (~> 1.3)
+  cuke_mem (~> 0.1.1)
+  jeweler (~> 1.8)
+  json_spec (~> 1.1.1)
+  rake (~> 10.1)
+  rspec (~> 2.14)
+  ruby_protobuf (~> 0.4.11)

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (C) 2013 Connamara Systems, llc
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,165 @@
+protobuf\_spec [![Build Status](https://travis-ci.org/connamara/protobuf_spec.png)](https://travis-ci.org/connamara/protobuf_spec)
+=============
+
+RSpec matchers and Cucumber step definitions for testing Protocol Buffers using [json_spec](https://github.com/collectiveidea/json_spec)
+
+Usage
+-----
+
+### RSpec
+
+protobuf\_spec currently defines two matchers:
+
+* ```be_protobuf_eql```
+* ```have_protobuf_path```
+
+The matchers can be used as their counterparts are used in json\_spec
+
+
+### Cucumber
+
+protobuf\_spec provides cucumber steps that use its RSpec matchers.
+
+In order to use the Cucumber steps, in your ```env.rb``` you must:
+
+```ruby
+require "protobuf_spec/cucumber"
+```
+
+You will need to load the ruby_protobuf generated classes you intend to test.  This can be done by generating the classes into the cucumber ```support/``` directory, or requiring them manually.
+
+#### "Should" Assertions 
+
+In order to test the contents of a Protocol Buffer, you will need to define a ```last_protobuf``` method.  This method should return the protocol buffer to be tested by a protobuf_spec Cucumber step. 
+
+For example, suppose a step that aquires a Protocol Buffer and assigns it to ```@my_protocol_buffer```.  In your ```features/support/env.rb``` you could then have
+
+```ruby
+def last_protobuf
+  @my_protocol_buffer
+end
+```
+
+See ```features/support/env.rb``` for a very simple implementation.
+
+Now you can use proto_spec steps in your features:
+
+
+```cucumber
+Feature: Weather API
+  Background: 
+    Given the weather is 58 degrees and cloudy in Chicago
+    And the weather is 72 degrees and sunny in Portland
+
+  Scenario: I can request the weather for a city
+    When I request weather for Portland
+    Then I should receive a ProtoBuf of type com.weather.WeatherResponse
+    And the ProtoBuf at "condition" should be "sunny"
+    And the ProtoBuf at "temperature" should be 72
+
+    When I request weather for Chicago
+    Then I should receive a ProtoBuf of type com.weather.WeatherResponse
+    And the ProtoBuf should be:
+    """
+    {
+      "condition":"sunny",
+      "temperature":58
+    }
+    """
+
+  Scenario: I can check if I need an umbrella
+    When I request the forecast for Chicago
+    Then I should receive a ProtoBuf of type com.weather.ForecastResponse
+    And the ProtoBuf should have "bring_umbrella"
+    And the ProtoBuf at "bring_umbrella" should be true
+```
+
+The background and request/receive steps above aren't provided by protobuf_spec.  The remaining steps protobuf_spec provides.  See [json_spec documentation](https://github.com/collectiveidea/json_spec) for more examples
+
+#### Building Protobufs
+
+In order to use the Cucumber steps for building protocol buffers, in your ```env.rb``` you must:
+
+```ruby
+require "protobuf_spec/builder"
+```
+Now you can use proto_spec builder steps in your features:
+
+```cucumber
+Feature: Weather Request API
+  Background: 
+    Given the weather is 58 degrees and cloudy in Chicago
+    And the weather is 72 degrees and sunny in Portland
+
+  Scenario: I can request the weather for a city by protocol buffer
+    Given I create a ProtoBuf of type "com::weather::WeatherRequest"
+    And I set the ProtoBuf at "city" to "Portland"
+    And I set the ProtoBuf at "zipcode" to 97211    
+    When I send the request
+    Then I should receive a ProtoBuf of type com::weather::WeatherResponse
+    And the ProtoBuf at "condition" should be "sunny"
+    And the ProtoBuf at "temperature" should be 72
+
+    Given I create the following protobuf of type "com::weather::WeatherRequest":
+    """
+    {
+      "city": "Chicago",
+      "zipcode": 60606    
+    }
+    """
+    When I send the request
+    Then I should receive a ProtoBuf of type com::weather::WeatherResponse
+    And the ProtoBuf at "condition" should not be "sunny"
+    And the ProtoBuf at "temperature" should be 58
+```
+
+The built protocol buffer can be accessed through the ```protobuf``` function in the ```ProtobufSpec::Builder``` module.
+
+### More
+
+Check out [specs](https://github.com/connamara/protobuf_spec/blob/master/spec) and [features](https://github.com/connamara/protobuf_spec/blob/master/features) to see all the ways you can use protobuf_spec.
+
+Install
+-------
+
+```shell
+gem install protobuf_spec
+```
+
+or add the following to Gemfile:
+```ruby
+gem 'protobuf_spec'
+```
+and run `bundle install` from your shell.
+
+More Information
+----------------
+
+* [Rubygems](https://rubygems.org/gems/protobuf_spec)
+* [Issues](https://github.com/connamara/protobuf_spec/issues)
+* [Connamara Systems](http://connamara.com)
+
+Contributing
+------------
+
+Please see the [contribution guidelines](https://github.com/connamara/protobuf_spec/blob/master/CONTRIBUTION_GUIDELINES.md).
+
+Credits
+-------
+
+Contributers:
+
+* Chris Busbey
+
+![Connamara Systems](http://www.connamara.com/images/home-connamara-logo-lg.png)
+
+protobuf_spec is maintained and funded by [Connamara Systems, llc](http://connamara.com).
+
+The names and logos for Connamara Systems are trademarks of Connamara Systems, llc.
+
+Licensing
+---------
+
+protobuf_spec is Copyright © 2013 Connamara Systems, llc. 
+
+This software is available under the GPL and a commercial license.  Please see the [LICENSE](https://github.com/connamara/protobuf_spec/blob/master/LICENSE.txt) file for the terms specified by the GPL license.  The commercial license offers more flexible licensing terms compared to the GPL, and includes support services.  [Contact us](mailto:info@connamara.com) for more information on the Connamara commercial license, what it enables, and how you can start developing with it.

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:cucumber)
+
+task :test => [:spec, :cucumber]
+task :default => :test
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "protobuf_spec"
+  gem.homepage = "http://github.com/connamara/protobuf_spec"
+  gem.license = "GPL"
+  gem.summary = %Q{RSpec matchers and cucumber step defs for testing protocol buffers}
+  gem.description = %Q{Leverages json_spec to test structured protocol buffers with json data modeling}
+  gem.email = "info@connamara.com"
+  gem.authors = ["Chris Busbey"]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/features/builder.feature

@@ -0,0 +1,34 @@
+Feature: Building ProtoBufs
+    Scenario: I can create a blank protocol buffer
+      Given I create a ProtoBuf of type "Sample"
+      When I get the ProtoBuf
+      Then the ProtoBuf should not have "string_field"
+      Then the ProtoBuf should not have "int_field"
+      Then the ProtoBuf should not have "double_field"
+
+    Scenario: I can set values of the protocol buffer
+      Given I create a ProtoBuf of type "Sample"
+      And I set the ProtoBuf at "string_field" to "hello"
+      And I set the ProtoBuf at "int_field" to -5
+      And I set the ProtoBuf at "double_field" to 123.45
+      When I get the ProtoBuf
+      Then the ProtoBuf at "string_field" should be "hello"
+      And the ProtoBuf at "int_field" should be -5
+      And the ProtoBuf at "double_field" should be 123.45
+
+    Scenario: I can create a protobuf with a json description
+      Given I create the following ProtoBuf of type "Sample":
+      """
+      {
+        "string_field": "foo",
+        "int_field": 5,    
+        "double_field": 50.23,    
+        "int_field_2": -9    
+      }
+      """
+
+      When I get the ProtoBuf
+      Then the ProtoBuf at "string_field" should be "foo"
+      And the ProtoBuf at "int_field" should be 5
+      And the ProtoBuf at "double_field" should be 50.23
+      And the ProtoBuf at "int_field_2" should be -9

data/features/equivalence.feature

@@ -0,0 +1,95 @@
+Feature: Equivalence
+  Background:
+    Given I create the following ProtoBuf of type "Sample":
+    """
+    {
+      "string_field": "foo",
+      "int_field": 5,    
+      "double_field": 50.23,    
+      "int_field_2": -9,    
+      "bool_field": true,
+      "bool_field_2": false
+    }
+    """
+
+    Scenario: Identical Protobuf
+    When I get the ProtoBuf
+    Then the Protobuf should be:
+    """
+    {
+      "string_field": "foo",
+      "int_field": 5,    
+      "double_field": 50.23,    
+      "int_field_2": -9,    
+      "bool_field": true,
+      "bool_field_2": false
+    }
+    """
+
+    Scenario: String
+    When I get the ProtoBuf
+    Then the ProtoBuf at "string_field" should be "foo"
+    Then the protobuf at "string_field" should be:
+    """
+    "foo"
+    """
+    Then the ProtoBuf at "string_field" should not be "bar"
+
+    Scenario: Integer
+    When I get the ProtoBuf
+    Then the ProtoBuf at "int_field" should be 5
+    Then the ProtoBuf at "int_field" should not be 15
+
+
+    Scenario: Negative Integer
+    When I get the ProtoBuf
+    Then the ProtoBuf at "int_field_2" should be -9
+    Then the ProtoBuf at "int_field_2" should not be -19
+
+    Scenario: Double
+    When I get the ProtoBuf
+    Then the ProtoBuf at "double_field" should be 50.23
+    And the ProtoBuf at "double_field" should be 50.23e0
+    And the ProtoBuf at "double_field" should be 50.23e+0
+    And the ProtoBuf at "double_field" should be 50.23e-0
+    And the ProtoBuf at "double_field" should be 50.23e0
+    And the ProtoBuf at "double_field" should be 50.23e+0
+    And the ProtoBuf at "double_field" should be 50.23e-0
+    And the ProtoBuf at "double_field" should be 5.023e1
+    And the ProtoBuf at "double_field" should be 5.023e+1
+    And the ProtoBuf at "double_field" should be 502.3e-1
+    And the ProtoBuf at "double_field" should be:
+      """
+      50.23
+      """
+    
+    Then the ProtoBuf at "double_field" should not be -15.45
+
+    Scenario: True
+    When I get the ProtoBuf
+    Then the protobuf at "bool_field" should be true
+    Then the protobuf at "bool_field" should be:
+    """
+    true
+    """
+    Then the protobuf at "bool_field" should not be false
+
+    Scenario: False
+    When I get the ProtoBuf
+    Then the protobuf at "bool_field_2" should be false
+    Then the protobuf at "bool_field_2" should be:
+    """
+    false
+    """
+    Then the protobuf at "bool_field_2" should not be true
+
+    Scenario: Table format
+    When I get the ProtoBuf
+    Then the protobuf should have the following:
+    | string_field    |  "foo"  |
+    | int_field       | 5       |    
+    | double_field    | 50.23   |    
+    | int_field_2     | -9      |
+    | bool_field      | true    |
+    | bool_field_2    | false   |
+