command_feedback 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Christian Schwartz
+
+MIT License
+
+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,29 @@
+# Command::Feedback
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'command-feedback'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install command-feedback
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/command_feedback

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require "command_feedback"
+require "optparse"
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage command-feedback [options] title choice1 choice2 ..."
+
+  options[:description] = ""
+  opts.on('-d', '--description DESCRIPTION', 'Add a description to the survey') do |description|
+    options[:description] =  description
+  end
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+
+optparse.parse!
+
+if ARGV.length > 2
+  title = ARGV.shift
+  choices = ARGV
+  description = options[:description]
+  feedback = CommandFeedback::Service.get_feedback title, choices, description
+  if feedback.successfull?
+    puts "Successfully created the feedback:"
+    puts "\t* Administration Link: #{ feedback.admin_link }"
+    puts "\t* Feedback Link: #{ feedback.feedback_link }"
+  else
+    puts "Failed to create the feedback:"
+    puts "\t* #{feedback.errors.join "\n\t* "}"
+  end
+else
+  puts optparse
+end

data/command_feedback.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'command_feedback/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "command_feedback"
+  gem.version       = CommandFeedback::VERSION
+  gem.authors       = ["Christian Schwartz"]
+  gem.email         = ["christian.schwartz@gmail.com"]
+  gem.description   = %q{An API and commandline tool for get-feedback.at}
+  gem.summary       = %q{An API and commandline tool for get-feedback.at}
+  gem.homepage      = "http://www.get-feedback.at"
+
+  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.add_dependency "httparty"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "vcr"
+end

data/lib/command_feedback.rb

@@ -0,0 +1,6 @@
+require "command_feedback/version"
+
+module CommandFeedback
+end
+
+require "command_feedback/feedback"

data/lib/command_feedback/feedback.rb

@@ -0,0 +1,77 @@
+require "httparty"
+
+
+module CommandFeedback
+  class Service
+    def self.get_feedback title, choices, description = ""
+      service = Service.new title, choices, description
+      service.process
+    end
+
+    def initialize title, choices, description
+      body = { 
+        "multiplechoice" => {
+          "title" => title,
+          "description" => description,
+          "choices" => Service.build_choices_hash(choices)
+        } 
+      }
+      options = { :headers => { 'ContentType' => 'application/json' } }
+
+      hostname = "get-feedback.at"
+      @response = HTTParty.post "http://#{ hostname }/questions.json", :body => body, :options => options
+    end
+
+    def self.build_choices_hash(choices)
+      choices_hash = {}
+      choices.each_with_index { |choice, index|
+        choices_hash["choice_#{index + 1}"] = choice
+      }
+      choices_hash
+    end
+
+    def process
+      if was_successful?
+        SuccessfulFeedback.new(@response["question"])
+      else
+        ErrorFeedback.new(@response["errors"])
+      end
+    end
+
+    def was_successful?
+      @response.include? "question" and
+        @response["question"].include? "admin_link" and
+        @response["question"].include? "feedback_link"
+    end
+
+    class ErrorFeedback
+      attr_reader :errors
+
+      def initialize(error_data)
+        @errors = []
+        error_data.each { |attribute, errors|
+          errors.each { |error|
+            @errors << "#{attribute} #{error}"
+          }
+        }
+      end
+
+      def successfull?
+        false
+      end
+    end
+
+    class SuccessfulFeedback
+      attr_reader :admin_link, :feedback_link
+
+      def initialize(data_json)
+        @admin_link = data_json["admin_link"]
+        @feedback_link = data_json["feedback_link"]
+      end
+
+      def successfull?
+        true
+      end
+    end
+  end
+end

data/lib/command_feedback/version.rb

@@ -0,0 +1,3 @@
+module CommandFeedback
+  VERSION = "0.0.1"
+end

data/spec/cassetes/successfull.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://get-feedback.at/questions.json
+    body:
+      encoding: US-ASCII
+      string: multiplechoice[title]=A%20title&multiplechoice[description]=A%20Description&multiplechoice[choices][choice_1]=Choice%201&multiplechoice[choices][choice_2]=Choice%202
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 14 Oct 2012 15:32:14 GMT
+      Server:
+      - Apache/2.2.14 (Ubuntu)
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.17
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"8cef4b17860e39dc513506b0aa385496"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 4cbc6dc59e3ca826f76ddecbe46fb62f
+      X-Runtime:
+      - '0.447327'
+      X-Rack-Cache:
+      - invalidate, pass
+      Set-Cookie:
+      - _get_feedback_session=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJThmZWYxNTMzNzcyNWQxYTFjYWI4NDE2ZTc4OWE4ZWFkBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMWNweWhVdjFlM0t0c3JmY0FhcndiT2Q1SnI5VmcwNi9iQmNnbktFYklXcDA9BjsARg%3D%3D--495418c28ab14109964f99648c06450b9bc8939a;
+        path=/; HttpOnly
+      Status:
+      - '200'
+      Content-Length:
+      - '135'
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: US-ASCII
+      string: ! '{"question":{"admin_link":"http://get-feedback.at/questions/7-admin-RR12","feedback_link":"http://get-feedback.at/answers/new.7-RR12"}}'
+    http_version: 
+  recorded_at: Sun, 14 Oct 2012 15:32:19 GMT
+recorded_with: VCR 2.2.5

data/spec/cassetes/unsuccessfull-choices.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://get-feedback.at/questions.json
+    body:
+      encoding: US-ASCII
+      string: multiplechoice[title]=A%20title&multiplechoice[description]=A%20Description&multiplechoice[choices][choice_1]=Choice%201
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 14 Oct 2012 15:32:20 GMT
+      Server:
+      - Apache/2.2.14 (Ubuntu)
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.17
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"82ab65a739525c5dff9c645e6072c1cc"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - be7e7b36bceffd473f83ca43fb6ab30d
+      X-Runtime:
+      - '0.008238'
+      X-Rack-Cache:
+      - invalidate, pass
+      Set-Cookie:
+      - _get_feedback_session=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJThiNzMwZjc1NTBiMjdiYTI0N2Q4NzJjMGVkZTgxNDgwBjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMXcycGttUDRiUlYvN0R0aDdCM2VOQ2FYZXQyak81NXZDaFIwUW9JTzZlQW89BjsARg%3D%3D--52eeede2ff97c40ca8c88ed33dee0ff1915e3e41;
+        path=/; HttpOnly
+      Status:
+      - '200'
+      Content-Length:
+      - '159'
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: US-ASCII
+      string: ! '{"question":{"title":"A title","description":"A Description","choices":[{"description":"Choice
+        1"}]},"errors":{"choices":["must contain at least two items."]}}'
+    http_version: 
+  recorded_at: Sun, 14 Oct 2012 15:32:20 GMT
+recorded_with: VCR 2.2.5

data/spec/cassetes/unsuccessfull-title.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://get-feedback.at/questions.json
+    body:
+      encoding: US-ASCII
+      string: multiplechoice[title]=A&multiplechoice[description]=A%20Description&multiplechoice[choices][choice_1]=Choice%201&multiplechoice[choices][choice_2]=Choice%202
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 14 Oct 2012 15:32:19 GMT
+      Server:
+      - Apache/2.2.14 (Ubuntu)
+      X-Powered-By:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.17
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"9a234567d8e380cc47bec7cd146b5fb8"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - e6e043692179d80355e74591a300bdd2
+      X-Runtime:
+      - '0.047420'
+      X-Rack-Cache:
+      - invalidate, pass
+      Set-Cookie:
+      - _get_feedback_session=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJTlmMmM2YmYwYzk4NzUzMGQ5Yzc5ZTczYzQwODg2MTI3BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMTdLU3kvdVFsOVlGZFBWdncydjZ2bnZtalBUaHJHRU9GY0Vuc24xRW9OSWM9BjsARg%3D%3D--53daa44ceb6c1cd3198b201b4d781d08b0589e57;
+        path=/; HttpOnly
+      Status:
+      - '200'
+      Content-Length:
+      - '184'
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: US-ASCII
+      string: ! '{"question":{"title":"A","description":"A Description","choices":[{"description":"Choice
+        1"},{"description":"Choice 2"}]},"errors":{"title":["is too short (minimum
+        is 4 characters)"]}}'
+    http_version: 
+  recorded_at: Sun, 14 Oct 2012 15:32:20 GMT
+recorded_with: VCR 2.2.5

data/spec/command_feedback_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+include CommandFeedback
+
+describe Service do
+  describe "calls out to the REST api" do
+    it "successfull" do
+      VCR.use_cassette "successfull" do
+        feedback = Service.get_feedback "A title", ["Choice 1", "Choice 2"], "A Description"
+        expect(feedback.successfull?).to eq(true)
+        expect(feedback.admin_link).to eq("http://get-feedback.at/questions/7-admin-RR12")
+        expect(feedback.feedback_link).to eq("http://get-feedback.at/answers/new.7-RR12")
+      end
+    end
+
+    it "unsuccessfull, too short title" do
+      VCR.use_cassette "unsuccessfull-title" do
+        feedback = Service.get_feedback "A", ["Choice 1", "Choice 2"], "A Description"
+        expect(feedback.successfull?).to eq(false)
+        expect(feedback.errors).to include('title is too short (minimum is 4 characters)')
+      end
+    end
+
+    it "unsuccessfull, not enough choices" do
+      VCR.use_cassette "unsuccessfull-choices" do
+        feedback = Service.get_feedback "A title", ["Choice 1"], "A Description"
+        expect(feedback.successfull?).to eq(false)
+        expect(feedback.errors).to include('choices must contain at least two items.')
+      end
+    end
+
+  end
+
+    it "builds a choices hash" do
+    choices = ["a", "b"]
+    expect(Service.build_choices_hash(choices)).to eq({"choice_1" => "a", "choice_2" => "b"})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "command_feedback"
+
+require "vcr"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/cassetes"
+  c.hook_into :webmock
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: command_feedback
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Schwartz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An API and commandline tool for get-feedback.at
+email:
+- christian.schwartz@gmail.com
+executables:
+- command_feedback
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/command_feedback
+- command_feedback.gemspec
+- lib/command_feedback.rb
+- lib/command_feedback/feedback.rb
+- lib/command_feedback/version.rb
+- spec/cassetes/successfull.yml
+- spec/cassetes/unsuccessfull-choices.yml
+- spec/cassetes/unsuccessfull-title.yml
+- spec/command_feedback_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.get-feedback.at
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An API and commandline tool for get-feedback.at
+test_files:
+- spec/cassetes/successfull.yml
+- spec/cassetes/unsuccessfull-choices.yml
+- spec/cassetes/unsuccessfull-title.yml
+- spec/command_feedback_spec.rb
+- spec/spec_helper.rb