paper-cup 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c054ba7ea95a3cfa40854c40bab74792c382357f
-  data.tar.gz: 227b099b1929205290b9c7be3b626fb9fb624d5d
+  metadata.gz: 6156fc04976c406a46b84b646cdc3f975b4c53e9
+  data.tar.gz: 40c7abe81e80b6934f1906f30ebd209fbfd7c704
 SHA512:
-  metadata.gz: 14361cf1f1b3ee531b61a934eb05244b76905fb43ddc53b18ea38cf5e69b2d838022ba824980a7f41c29907dd50423a293fa21f26b85f7677b14b32e030f1f2d
-  data.tar.gz: a1c986904938cefe659eff2a214b20ecb78e2489ff337f3f9e3d3e1a179c94d5ef902787e4afd84219af6b2afcc0dd4255bbeb6052b501d033c4c2720f66a3c5
+  metadata.gz: fed562528e8e17efda88a0ee1ccb92f8a444feab8776c6d8680125281beeb92fe07373b285a490332b44329cd65bf517ab7fc20347591ed2271f69915eb5798e
+  data.tar.gz: 75a5813a7847d2eae1a5f1df5b3d1b3c5412ee096a02e1107b29345d0d6c0413c27017927d4c2fb4c0835d884f9d2dc2d4dba706f827757c5c93be89ffc6ccb8

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+install: bundle install
+rvm:
+  - 2.2.1
+script:
+  - RUBYOPT=-W0 bundle exec rake test
+git:
+  depth: 10
+notifications:
+  email: false
+before_install:
+  - gem install bundler -v '= 1.10.6'

data/README.md

@@ -1,3 +1,7 @@
+# PaperCup
+
+![TravisCI Badge](https://magnum.travis-ci.com/casapick/paper-cup.svg?token=MzqzdCmqpmmxRGFLmFqv&branch=master)
+
 Instalation
 ----
 
@@ -11,7 +15,18 @@ None!!! Yeaaaah!
 Usage
 -----
 
-At the moment it only works for `POSTs`, `GETs` and `PUTs`. If the the response is a JSON the gem will parse it, if not it will show as it cames
+At the moment it only works for `POSTs`, `HEAD`s, `GETs` and `PUTs`. If the response is a JSON the gem will parse it, if not it will show as it cames
+
+PaperCup only has these 4 methods: `#get`, `#head`, `#post` and `#put`.
+
+For all the methods it accepts the next parameters:
+
+  * url: is mandatory
+  * headers: optional, it has to be a hash. Example: `{ "Content-Type" => "application/json"}`
+  * params: optional, same as the header. Example: { name: "Goku", race: "Saiyan" }
+  * body: optional, the body will be inserted with the [`-d`](http://curl.haxx.se/docs/manpage.html#-d) option of curl as it come.
+
+All the method returns a [`Response`](https://github.com/casapick/paper-cup/blob/master/lib/paper_cup/response.rb) object, that has two attributes status and body. The status is the status code of the respond and the body is the response.
 
 GET
 ----
@@ -21,7 +36,7 @@ GET
 POST - PUT
 ----------
 
-`PaperCup.post(url: url, body: {name: 'pepe'}, headers: { "Content-Type" => "application/json"})`
+`PaperCup.post(url: url, params: {name: 'pepe'}, headers: { "Content-Type" => "application/json"})`
 
 
 Response
@@ -31,7 +46,7 @@ Each request will return a `Response` object.
 Example:
 
 ```ruby
-  r = PaperCup.post(url, some_hash.to_json)
-  puts r.response # It will print the response returned by the endpoint
+  r = PaperCup.post(url, body: some_hash.to_json, headers: { "Content-Type" => "application/json"})
+  puts r.body # It will print the response returned by the endpoint
   puts r.status # It will print the status code returned by the endpoint
 ```

data/Rakefile

@@ -0,0 +1,10 @@
+# Dir.glob(['./lib/tasks/*.rake']).each { |r| require r }
+
+require 'rake/testtask'
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb', "test/paper_cup_test/**_test.rb"]
+  t.verbose = true
+end

data/lib/paper_cup/response.rb

@@ -3,14 +3,14 @@ require_relative 'utils'
 
 module PaperCup
   class Response
-    attr_accessor :status, :response
+    attr_accessor :status, :body
 
     def initialize(raw_response)
       @raw_response = raw_response
     end
 
-    def response
-      @response ||= begin
+    def body
+      @body ||= begin
         str = @raw_response[0..-4]
         PaperCup.valid_json?(str) ? JSON.parse(str) : str
       end

data/paper-cup.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'paper-cup'
-  s.version     = '0.1.1'
+  s.version     = '0.1.2'
   s.date        = '2015-08-05'
   s.summary     = "Use of Open3 to make request"
   s.description = "Use curl with Open3 for making request"
@@ -15,4 +15,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "minitest", '~> 5.8.0'
   s.add_development_dependency "minitest-happy", '~> 1.0.0'
   s.add_development_dependency "pry", '~> 0.10.1'
+  s.add_development_dependency "rake", '~> 10.4.2'
 end

data/test/paper_cup_test.rb

@@ -7,7 +7,7 @@ describe PaperCup do
       it "must parse the response" do
         Open3.stub :capture3, [Mock.json] do   # stub goes away once the block is done
           r = PaperCup.get("http://www.google.com")
-          assert_equal "Rails", r.response.first["framework"], "The framework must be rails"
+          assert_equal "Rails", r.body.first["framework"], "The framework must be rails"
         end
       end
     end
@@ -15,7 +15,7 @@ describe PaperCup do
       it "must set the response as it come" do
         Open3.stub :capture3, [Mock.html] do   # stub goes away once the block is done
           r = PaperCup.get("http://www.google.com")
-          assert_equal Mock.html, "#{r.response}#{r.status}", "The response must be the same"
+          assert_equal Mock.html, "#{r.body}#{r.status}", "The response must be the same"
         end
       end
     end

data/test/paper_cup_test/response_test.rb

@@ -17,7 +17,7 @@ describe PaperCup::Response do
   describe "when the response is a JSON" do
     it "must set the response properly" do
       r = PaperCup::Response.new(Mock.json)
-      assert_equal JSON.parse(Mock.json[0..-4]), r.response
+      assert_equal JSON.parse(Mock.json[0..-4]), r.body
     end
 
     it "must set the status code response properly" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper-cup
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mariano Matayoshi
@@ -54,6 +54,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 description: Use curl with Open3 for making request
 email: matayoshi.mariano@gmail.com
 executables: []
@@ -61,8 +75,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
+- Rakefile
 - lib/paper_cup.rb
 - lib/paper_cup/request.rb
 - lib/paper_cup/response.rb