paper-cup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d26bd9a2d6d938e5548afdc7d6fc007351bce1aa
+  data.tar.gz: 72d254b6cecb88fc6218ad3dcdf125a01da5dfed
+SHA512:
+  metadata.gz: c13a59518e7e3839d5945b40c7e4a33ac6d755afe4bf74c7adf19477ba90bae302b370e5134c3480080c49e2e7bb6ba7ab3c2d6129f782a3ab274cd077f2408c
+  data.tar.gz: 3425637ac57ea033ff2e7e113802bf858eee11d131a352425e2e4d76a966f2e3a48d277cdeb4c0e85a8a67e1738b726a5d40e29b21dafe94ac099bf883597ac0

data/.gitignore

@@ -0,0 +1,13 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+pkg
+*.swp
+.ruby-version

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+Instalation
+----
+
+Add `gem paper-cup` to your gemfile.
+
+Configuration
+-----
+
+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
+
+GET
+----
+
+`PaperCup.get(url: url)`
+
+POST - PUT
+----------
+
+`PaperCup.post(url: url, body: {name: 'pepe'}, headers: { "Content-Type" => "application/json"})`
+
+
+Response
+---------
+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
+  puts r.status # It will print the status code returned by the endpoint
+```

data/lib/paper_cup/request.rb

@@ -0,0 +1,45 @@
+require "open3"
+require_relative 'response'
+
+module PaperCup
+  class Request
+
+    attr_accessor :method, :url, :headers, :params, :body
+
+    COMMAND_TEMPLATE = "curl -X %{method} -w %%{http_code} %{headers} %{params} %{body} %{url}"
+
+    def initialize(method:, url:, headers: {}, params: {}, body: "")
+      @url, @method, @headers, @params, @body = url, method, headers, params, body
+    end
+
+    def exec
+      Response.new(Open3.capture3(command).first)
+    end
+
+    def command
+      COMMAND_TEMPLATE % {
+        method:  method.upcase,
+        headers: build_headers,
+        params:  build_params,
+        body:    build_body,
+        url:     url
+      }
+    end
+
+    def build_headers
+      @headers.map { |k, v| "-H '#{k}: #{v}'" }.join(" ")
+    end
+
+    def build_params
+      json_request? ? "-d '#{params.to_json}'" : "-d '#{params}'"
+    end
+
+    def json_request?
+      @headers["Content-Type"] && @headers["Content-Type"].include?("json")
+    end
+
+    def build_body
+      body.empty? ? "" : "-d '#{body}'"
+    end
+  end
+end

data/lib/paper_cup/response.rb

@@ -0,0 +1,27 @@
+require 'json'
+require_relative 'utils'
+
+module PaperCup
+  class Response
+    attr_accessor :status, :response
+
+    def initialize(raw_response)
+      @raw_response = raw_response
+    end
+
+    def response
+      @response ||= begin
+        str = @raw_response[0..-4]
+        PaperCup.valid_json?(str) ? JSON.parse(str) : str
+      end
+    end
+
+    def status
+      @status ||= @raw_response[-3..-1].to_i
+    end
+
+    def success?
+      status.between?(200, 299)
+    end
+  end
+end

data/lib/paper_cup/utils.rb

@@ -0,0 +1,8 @@
+module PaperCup
+  def self.valid_json?(json)
+    JSON.parse(json)
+    true
+  rescue
+    false
+  end
+end

data/lib/paper_cup.rb

@@ -0,0 +1,13 @@
+require "./lib/paper_cup/request.rb"
+module PaperCup
+
+  INSERT_METHODS = %w(post put)
+  QUERY_METHODS = %w(get head)
+  METHODS = INSERT_METHODS + QUERY_METHODS
+
+  METHODS.each do |method|
+    define_singleton_method(method) do |url, opts = {}|
+      Request.new(opts.merge(url: url, method: method)).exec
+    end
+  end
+end

data/paper-cup.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'paper-cup'
+  s.version     = '0.1.0'
+  s.date        = '2015-08-05'
+  s.summary     = "Use of Open3 to make request"
+  s.description = "Use curl with Open3 for making request"
+  s.authors     = ["Mariano Matayoshi", "Ricardo Kleine Samson", "Nicolas Oga"]
+  s.email       = 'matayoshi.mariano@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/casapick/paper-cup'
+  s.license     = 'MIT'
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest", '~> 0'
+  s.add_development_dependency "minitest-happy", '~> 0'
+  s.add_development_dependency "pry-byebug", '~> 0'
+end

data/test/paper_cup_test/request_test.rb

@@ -0,0 +1,60 @@
+require "test_helper"
+
+describe PaperCup::Request do
+
+  describe "when the request is only url and method" do
+    it "must upcase the method for the command" do
+      r = PaperCup::Request.new(method: "get", url: "https://www.google.com.ar")
+      assert r.command.include?("-X GET"), "The command does not have the method upcased"
+    end
+
+    it "must add 'httt_code' to the command in order to get the status code" do
+      r = PaperCup::Request.new(method: "get", url: "https://www.google.com.ar")
+      assert r.command.include?("-w %{http_code}"), "The command does not include 'http_code'"
+    end
+  end
+
+  describe "when the request have headers" do
+    it "must add them to the command" do
+      r = PaperCup::Request.new(method: "get", url: "https://www.google.com.ar",
+                                headers: { "Content-Type" => "application/json"})
+      assert r.command.include?("-H 'Content-Type: application/json'"), "The command does not have the method upcased"
+    end
+  end
+
+  describe "when the request\'s content type is json" do
+    it "the params must be json" do
+      params = { pepe: { holis: 3 }, pepa: 3 }
+      r = PaperCup::Request.new(method: "get", url: "https://www.google.com.ar",
+                                params: params,
+                                headers: { "Content-Type" => "application/json"})
+      assert r.command.include?(params.to_json), "The command does not have the params as a json"
+    end
+  end
+
+  describe "when the request\'s content type is not json" do
+    it "the params must be json" do
+      params = "<html><header></header><body><h1>HOLA</h1></body></html>"
+      r = PaperCup::Request.new(method: "get", url: "https://www.google.com.ar",
+                                params: params,
+                                headers: { "Content-Type" => "application/xml"})
+      assert r.command.include?(params), "The command does not have the params"
+    end
+  end
+
+  describe "when the request\'s have body" do
+    it "the body must be present" do
+      body = { total: 3.12 }.to_json
+      r = PaperCup::Request.new(method: "get", url: "https://www.google.com.ar",
+                                body: body, headers: { "Content-Type" => "application/json"})
+      assert r.command.include?(body), "The command does not have the body"
+    end
+  end
+
+  describe "when the request\'s have no body" do
+    it "there must not be an empty body" do
+      r = PaperCup::Request.new(method: "get", url: "https://www.google.com.ar")
+      refute r.command.include?("-d ''"), "The command does have the body"
+    end
+  end
+end

data/test/paper_cup_test/response_test.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+
+describe PaperCup::Response do
+
+  describe "when the response is not JSON" do
+    it "must set the response as it came " do
+      assert_nothing_raised { PaperCup::Response.new(Mock.html) }
+    end
+
+    it "must set the status code response properly" do
+      r = PaperCup::Response.new(Mock.html)
+      assert_equal 404, r.status
+    end
+
+  end
+
+  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
+    end
+
+    it "must set the status code response properly" do
+      r = PaperCup::Response.new(Mock.json)
+      assert_equal 200, r.status
+    end
+  end
+end

data/test/paper_cup_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+describe PaperCup do
+
+  describe "when doing a GET request to an url" do
+    describe "that respond with a JSON" 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"
+        end
+      end
+    end
+    describe "that does not respond with a JSON" 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"
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'pry'
+require './lib/paper_cup.rb'
+Dir.glob(['./lib/**/*.rb']).each { |r| require r }
+
+module Mock
+  class << self
+    def html
+      "<html>\n<head>\n<meta charset=\"UTF-8\">\n<title>404</title>\n</head>\n<body>\n<code>404</code>\n</body>\n</html>\n404"
+    end
+
+    def json
+      "[{\"framework\":\"Rails\",\"language\":\"ruby\"}]200"
+    end
+
+    def params
+      { framework: 'cuba', language: 'ruby' }
+    end
+  end
+end
+
+module Minitest::Assertions
+  def assert_nothing_raised(*)
+    yield
+  end
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: paper-cup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mariano Matayoshi
+- Ricardo Kleine Samson
+- Nicolas Oga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-happy
+  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: pry-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: Use curl with Open3 for making request
+email: matayoshi.mariano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/paper_cup.rb
+- lib/paper_cup/request.rb
+- lib/paper_cup/response.rb
+- lib/paper_cup/utils.rb
+- paper-cup.gemspec
+- test/paper_cup_test.rb
+- test/paper_cup_test/request_test.rb
+- test/paper_cup_test/response_test.rb
+- test/test_helper.rb
+homepage: https://github.com/casapick/paper-cup
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Use of Open3 to make request
+test_files: []
+has_rdoc: