paper-cup 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6156fc04976c406a46b84b646cdc3f975b4c53e9
-  data.tar.gz: 40c7abe81e80b6934f1906f30ebd209fbfd7c704
+  metadata.gz: 8c341398114a2a9df8db16fdabaafaeddc12112c
+  data.tar.gz: faf80ab69ab9ab93de024834cd141791c6332b06
 SHA512:
-  metadata.gz: fed562528e8e17efda88a0ee1ccb92f8a444feab8776c6d8680125281beeb92fe07373b285a490332b44329cd65bf517ab7fc20347591ed2271f69915eb5798e
-  data.tar.gz: 75a5813a7847d2eae1a5f1df5b3d1b3c5412ee096a02e1107b29345d0d6c0413c27017927d4c2fb4c0835d884f9d2dc2d4dba706f827757c5c93be89ffc6ccb8
+  metadata.gz: d438c4b0506ccd7bb9da19cb1f8a02f533ac3b82fd278d0a37afde50cfbad6fbfb72e2a510bb07cf13665bc890cc4331585830aeeba48418d40af6d58c90d544
+  data.tar.gz: 817983209a7a5605beba459718e75b225c6d2b65a911f381dd46cade61bc9f357632f3cdd78f6c71a028a0bf9916dbec7e1c2e41d3ae29de3f5d7f3bd7771702

data/README.md

@@ -1,6 +1,6 @@
 # PaperCup
 
-![TravisCI Badge](https://magnum.travis-ci.com/casapick/paper-cup.svg?token=MzqzdCmqpmmxRGFLmFqv&branch=master)
+![TravisCI Badge](https://travis-ci.org/casapick/paper-cup.svg)
 
 Instalation
 ----
@@ -23,20 +23,44 @@ 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" }
+  * 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.
+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`.
+
+### Using a client
+You can also instantiate a client and store to make continous calls to the same domain. It can have default params and headers that will be used on all calls.
+
+~~~ruby
+client = PaperCup::Client.new url: 'https://api.github.com'
+client.get('users/casapick')
+~~~
+
+You can also "persist" an endpoint. You also can append headers and params:
+
+~~~ruby
+users = client.endpoint(:users)
+=> #<PaperCup::Client:0x007fba325a5188 @options={:url=>"https://api.github.com/users", :headers=>{}, :params=>{}}>
+
+response = users.get(:casapick)
+response.body
+=> {"login"=>"casapick",
+ "id"=>8136680,
+ "avatar_url"=>"https://avatars.githubusercontent.com/u/8136680?v=3",
+ # ...
+ "created_at"=>"2014-07-11T15:41:22Z",
+ "updated_at"=>"2015-07-29T18:39:00Z"}
+~~~
 
 GET
 ----
 
-`PaperCup.get(url: url)`
+`PaperCup.get(url)`
 
 POST - PUT
 ----------
 
-`PaperCup.post(url: url, params: {name: 'pepe'}, headers: { "Content-Type" => "application/json"})`
+`PaperCup.post(url, params: {name: 'pepe'}, headers: { "Content-Type" => "application/json"})`
 
 
 Response

data/lib/paper_cup/client.rb

@@ -0,0 +1,52 @@
+module PaperCup
+  class Client
+    attr_accessor :options
+
+    def initialize(opts)
+      @options = opts
+    end
+
+    def url
+      options.fetch(:url)
+    end
+
+    def headers
+      options[:headers] || {}
+    end
+
+    def params
+      options[:params] || {}
+    end
+
+    PaperCup::METHODS.each do |method|
+      define_method(method) do |path, opts = {}|
+        opts = merged_opts_for_request(
+          method: method,
+          path:   path,
+          **opts
+        )
+        Request.new(opts).exec
+      end
+    end
+
+    def endpoint(path, opts = {})
+      opts = merged_opts_for_request opts.merge(path: path)
+      opts.reject! do |k,v|
+        k == :method
+      end
+
+      return self.class.new(opts)
+    end
+
+    private
+
+    def merged_opts_for_request(opts)
+      _method  = opts[:method] || :get
+      _url     = File.join(url, opts.fetch(:path).to_s)
+      _headers = headers.merge(opts[:headers] || {})
+      _params  = params.merge(opts[:params] || {})
+
+      { method: _method, url: _url, headers: _headers, params: _params }
+    end
+  end
+end

data/lib/paper_cup.rb

@@ -1,6 +1,6 @@
 require "paper_cup/request"
-module PaperCup
 
+module PaperCup
   INSERT_METHODS = %w(post put)
   QUERY_METHODS = %w(get head)
   METHODS = INSERT_METHODS + QUERY_METHODS
@@ -11,3 +11,5 @@ module PaperCup
     end
   end
 end
+
+require "paper_cup/client"

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.2'
+  s.version     = '0.2.0'
   s.date        = '2015-08-05'
   s.summary     = "Use of Open3 to make request"
   s.description = "Use curl with Open3 for making request"

data/test/paper_cup_test/client_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+def client
+  @client ||= PaperCup::Client.new(
+    url:     'http://api.github.com',
+    params:  { test_param_1: :pepito, test_param_2: :pepita },
+    headers: { 'X-Test-Header-1': :pepote, 'X-Test-Header-2': :papita }
+  )
+end
+
+describe PaperCup::Client do
+  it '#merged_opts_for_request merges options properly' do
+    result = client.send :merged_opts_for_request, {
+      method:   :get,
+      path:     '/users/casapick',
+      params:   { test_param_2: :popote, test_param_3: :papota },
+      headers:  { 'X-Test-Header-2': :popote, 'X-Test-Header-3': :papota }
+    }
+
+    assert_equal result.fetch(:method), :get
+    assert_equal result.fetch(:url), 'http://api.github.com/users/casapick'
+    assert_equal result.fetch(:params), test_param_1: :pepito, test_param_2: :popote, test_param_3: :papota
+    assert_equal result.fetch(:headers), 'X-Test-Header-1': :pepote, 'X-Test-Header-2': :popote, 'X-Test-Header-3': :papota
+  end
+
+  it '#endpoint returns a new client with merged url, params and headers' do
+    users = client.endpoint(:users,
+      params:   { test_param_2: :popote, test_param_3: :papota },
+      headers:  { 'X-Test-Header-2': :popote, 'X-Test-Header-3': :papota }
+    )
+
+    assert_equal users.url, 'http://api.github.com/users'
+    assert_equal users.params, test_param_1: :pepito, test_param_2: :popote, test_param_3: :papota
+    assert_equal users.headers, 'X-Test-Header-1': :pepote, 'X-Test-Header-2': :popote, 'X-Test-Header-3': :papota
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper-cup
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Mariano Matayoshi
@@ -80,11 +80,13 @@ files:
 - README.md
 - Rakefile
 - lib/paper_cup.rb
+- lib/paper_cup/client.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/client_test.rb
 - test/paper_cup_test/request_test.rb
 - test/paper_cup_test/response_test.rb
 - test/test_helper.rb