coleslaw 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 555a63548c3d520fb4e890e4e6756354306468e3
-  data.tar.gz: 03ac2f8fdd61403580da8a2fd5367ab27d40badb
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWZmYmUxMjc1MWM1ZTQ2NGE0YWJlNzRiZmRmZmYyOGYwNjFkODViYQ==
+  data.tar.gz: !binary |-
+    ZWI2YTkwN2EyMTYyNGI5OTgyNmRkZDIwOWYyOGFiOTgyMWMyNmM3Nw==
 SHA512:
-  metadata.gz: 9b31009bceb38e2c03af75cae4e13ec2ada872d0b008287bd1ff189b5990f57d5877c89e5a8f98a53b4151a97ae05c6c429f5be77cf5f2ea39caa5b8655587b8
-  data.tar.gz: fd53e98bf83e67e1884d2207ae9584e98a7648a33c166cb654f832dbdfd64a901aa47adf56c118c5a8c6af9a89032d71a3abd1b76c13d666473a32006b2ba21c
+  metadata.gz: !binary |-
+    ZGY1NDMxOGQzY2NmMDczOGZjMGE4ZGJjNjYwMDA5Mjg0MDM3NGI5OTE5ZjJh
+    OGY3NDFiNWNkNTFiY2U2YmFiZThlMDBkNzc2NmM4ZGU1ZWU0MDU4YTE2ODg4
+    Yjk2OGM4MDQzYmU5MTFlZjRmNGIwNmIyNzljMWRmMDY2NGNmYjU=
+  data.tar.gz: !binary |-
+    MDdkZjEzNGYwYTk5YjE3NDQxYTliNTYzOGQwNTIxMzAxMmEyZGY3MDcwMWI5
+    ZTFiYzMyZjlkNzRiZDQyMjMyODBlMzZlOWY4NWFmZDgwMzc2NDc5NDQ2Y2Iy
+    MTg1ZTE3OTBmNWNiOGI1ODQ4MzI4ZDI5YmJkODkxNjA3NjM3NjQ=

data/README.md

@@ -1,12 +1,14 @@
-# Coleslaw::Gem
+# Coleslaw Gem
 
-TODO: Write a gem description
+ColeslawApp (http://www.coleslawapp.com) is an easy and sexy way to
+share your hard built Cucumber (Ruby) or Lettuce (Python) feature files
+with your product owner and maybe the world.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'coleslaw-gem'
+    gem 'coleslaw'
 
 And then execute:
 
@@ -14,11 +16,27 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install coleslaw-gem
+    $ gem install coleslaw
 
 ## Usage
 
-TODO: Write usage instructions here
+### Get your secret key
+  Visit http://www.coleslawapp.com and register an account there. You
+may also want to create a project in order to have a project token.
+
+Then visit https://www.coleslawapp.com/api_tokens and copy your secret
+token.
+### Upload the tests
+By default, coleslaw assume that your .feature file is in features/
+folder and your .xml test result file is in features/reports/. You can
+customize these with --features-dir and --reports-dir.
+
+Now run:
+  $ bundle exec coleslaw --token [Your secret token here] [Project Token]
+
+And viola, tests will be uploaded to Coleslaw and rendered. Visit
+https://www.coleslawapp.com/dashboard and start browsing your uploaded
+tests.
 
 ## Contributing
 

data/bin/coleslaw

@@ -16,7 +16,7 @@ end
 # Command Line Interface for https://www.coleslawapp.com - The easiest way to share your BDD features with product owner
 #
 # SYNOPSIS
-#   #{command_name} [options] PRODUCT_ID
+#   #{command_name} [options] PROJECT_TOKEN
 #
 # OPTIONS
 # #{summarized_options}
@@ -32,7 +32,7 @@ class Coleslaw < Quickl::Command(__FILE__, __LINE__)
   options do |opt|
     opt.on_tail('--help', "Show this help message"){ raise Quickl::Help }
     opt.on_tail('--version', "Show version and exit"){ raise Quickl::Exit, "#{Quickl.program_name} #{VERSION}" }
-    opt.on('--token [TOKEN]', "Set your access token") { |t| @token = t }
+    opt.on('--token [API_TOKEN]', "Set your access token") { |t| @token = t }
     opt.on('--features-dir [FDIR]', "Set the features directory, default to #{DEFAULT_FEATURES_DIR}") do |features_dir|
       @features_dir = features_dir
     end
@@ -86,17 +86,17 @@ class Coleslaw < Quickl::Command(__FILE__, __LINE__)
       raise Quickl::InvalidArgument, "Please provide token by either use --token or create .coleslaw file in your current working directory"
     end
 
-    product_id = args.first.to_i
+    project_token = args.first
 
-    unless product_id > 0
-      raise Quickl::InvalidArgument, "Invalid product id"
+    unless project_token
+      raise Quickl::InvalidArgument, "Please provide project token"
     end
 
     puts "Creating new test result..."
-    if (test_result_id = create_test_result(product_id))
+    if (test_result_id = create_test_result(project_token))
       test_result_files.each do |test_result_file|
         puts "Uploading [#{test_result_file}]"
-        upload_test_result_file(product_id, test_result_id, test_result_file)
+        upload_test_result_file(project_token, test_result_id, test_result_file)
       end
       puts "Successfully created test result ##{test_result_id}"
     end
@@ -106,9 +106,9 @@ class Coleslaw < Quickl::Command(__FILE__, __LINE__)
     { content_type: :json, :accept => :json, :'Token-Secret' => token }
   end
 
-  def create_test_result(product_id)
+  def create_test_result(project_token)
     response = RestClient.post(
-        server + "/products/#{product_id}/test_results",
+        server + "/projects/#{project_token}/test_results",
         {},
         **request_options
     )
@@ -120,17 +120,18 @@ class Coleslaw < Quickl::Command(__FILE__, __LINE__)
     nil
   end
 
-  def upload_test_result_file(product_id, test_result_id, test_result_file)
+  def upload_test_result_file(project_token, test_result_id, test_result_file)
     RestClient.post(
-        server + "/products/#{product_id}/test_results/#{test_result_id}/test_result_files",
-        {
-            test_result_file: {
-                path: test_result_file,
-                file: File.new(test_result_file, 'rb')
-            }
-        },
-        **request_options
-    )
+      server + "/projects/#{project_token}/test_results/#{test_result_id}/add_file",
+      {
+        file: File.new(test_result_file, 'rb')
+      },
+      **request_options
+    ) do |response, request, result, &block|
+      unless [301, 302, 307].include? response.code # RestClient does not handle redirects on POST
+        response.return!(request, result, &block)
+      end
+    end
   end
 
   def test_result_files

data/lib/coleslaw/gem/version.rb

@@ -1,5 +1,5 @@
 module Coleslaw
   module Gem
-    VERSION = "0.0.2"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: coleslaw
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Phuong Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quickl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -70,14 +70,14 @@ dependencies:
   name: byebug
   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: A gem that allow you to upload your test results to http://coleslawapp.com
@@ -107,17 +107,17 @@ 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
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: A gem that allow you to upload your test results to http://coleslawapp.com