xsr 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39ab889ea831529ef693fb4e8155a602fc967347
-  data.tar.gz: 197db55a65aa0f54fd1e8f4b0ef886d73c0ad902
+  metadata.gz: 931719af15817041f1826a036bd4315cd05ce1df
+  data.tar.gz: 26c3470bb7deb98cdce115aad6dc55afdfe31d7f
 SHA512:
-  metadata.gz: f3601a3830756dd838531c5d92f5291687c3cfd656efb281a58f490d4792114495d1a077bf2352209210fc69f21701587a099875b673e8bf67e7702d2463bff0
-  data.tar.gz: 87525098dbf9e68d27db92dc02d455f5ce7d58830a0741b65eddb2e92126630903ac22241bfb3e1f30e6a6b87332143402bf25f6255477691473202e7bacf3db
+  metadata.gz: 674f547fdd8f62a5921ff148023e80d58aac8d58f0c414045512ea688a36ea1065d7f4f7c4b39f1298374bd2c0f56f6d43ac01130c4036ed67c47893144d36ff
+  data.tar.gz: dea4adc7133a5ba9adc51ea096c6262ea2c6a195fde4a6e72205ef05e9991646e632c00aa719c569781a4ae16dc85c6175409e5d014a9c1513fcdc8787a3e6bc

data/lib/xsr/client.rb

@@ -1,4 +1,5 @@
 module XSR
+  # XSR Client class, holding methods to handle HTTP requests
   class Client
     attr_accessor :base_url
     attr_accessor :default_header
@@ -24,20 +25,22 @@ module XSR
       request_with_data(path, options) { |uri| Net::HTTP::Get.new(uri.to_s) }
     end
 
-  private
+    private
+
     def request_with_data(path, options = {})
-      args = options[:args] && URI::encode( options[:args].map{|k,v| "#{k}=#{v}"}.join('&').to_s )
-      uri = URI( @base_url.to_s + path.to_s + '?' + args.to_s )
+      # Set URI & arguments
+      args = options[:args] && URI.encode(options[:args].map { |k, v| "#{k}=#{v}" }.join('&').to_s)
+      uri = URI(@base_url.to_s + path.to_s + '?' + args.to_s)
 
       req = yield(uri)
 
       # Set headers
       req['Content-Type'] = 'application/json'
-      @base_header && @base_header.each{ |k,v| req[k.to_s] = v }
-      options[:header] && options[:header].each{ |k,v| req[k.to_s] = v }
+      @base_header && @base_header.each { |k, v| req[k.to_s] = v }
+      options[:header] && options[:header].each { |k, v| req[k.to_s] = v }
 
       # Set body
-      req.body = options[:body] && MultiJson.dump( options[:body] )
+      req.body = options[:body] && MultiJson.dump(options[:body])
 
       http_session = Net::HTTP.new(uri.host, uri.port)
 
@@ -46,7 +49,7 @@ module XSR
         http_session.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
 
-      XSR::Response.new( http_session.start{ |http| http.request(req) } )
+      XSR::Response.new http_session.start { |http| http.request(req) }
     end
   end
 end

data/lib/xsr/response.rb

@@ -1,11 +1,12 @@
 module XSR
-  class Response 
+  # Response object is created by Client after a HTTP call
+  class Response
     attr_reader :http_response
 
     def initialize(http_response)
       @http_response = http_response
     end
-    
+
     def success?
       @http_response.is_a? Net::HTTPSuccess
     end
@@ -18,12 +19,20 @@ module XSR
       @http_response.is_a? Net::HTTPNotFound
     end
 
+    def unauthorized?
+      @http_response.is_a? Net::HTTPUnauthorized
+    end
+
+    def forbidden?
+      @http_response.is_a? Net::HTTPForbidden
+    end
+
     def server_error?
       @http_response.is_a? Net::HTTPServerError
     end
 
     def body
-        MultiJson.load @http_response.body, symbolize_keys: true
+      MultiJson.load @http_response.body, symbolize_keys: true
     end
   end
 end

data/lib/xsr.rb

@@ -4,4 +4,4 @@ require 'multi_json'
 require 'openssl'
 
 require 'xsr/client'
-require 'xsr/response'
+require 'xsr/response'

data/test/client_test.rb

@@ -1,68 +1,78 @@
 require 'xsr'
 require_relative 'helper'
 
+# Tests for Client class
 module ClientTest
   prepare do
-    @client = XSR::Client.new( base_url: 'http://httpbin.org' )
+    @client = XSR::Client.new(base_url: 'http://httpbin.org')
   end
 
-  test "get request" do
+  test 'get request' do
     resp = @client.get('/get')
-    
+
     assert resp.http_response.instance_of?(Net::HTTPOK)
   end
 
-  test "post request" do
-    req = {some_key: 'some_value'}
-    resp = @client.post( '/post', {body: req} )
-    
+  test 'post request' do
+    req = { some_key: 'some_value' }
+    resp = @client.post('/post', body: req)
+
     assert resp.http_response.instance_of?(Net::HTTPOK)
-    assert_equal MultiJson.load(resp.http_response.body, symbolize_keys: true)[:json], req
+    assert_equal MultiJson.load(resp.http_response.body,
+                                symbolize_keys: true)[:json], req
   end
 
   test 'put request' do
-    req = {some_key: 'some_value'}
-    resp = @client.put( '/put', {body: req} )
+    req = { some_key: 'some_value' }
+    resp = @client.put('/put', body: req)
 
     assert resp.http_response.instance_of?(Net::HTTPOK)
-    assert_equal MultiJson.load(resp.http_response.body, symbolize_keys: true)[:json], req
+    assert_equal MultiJson.load(resp.http_response.body,
+                                symbolize_keys: true)[:json], req
   end
 
   test 'delete request' do
-    req = {some_key: 'some_value'}
-    resp = @client.delete( '/delete', {body: req} )
+    req = { some_key: 'some_value' }
+    resp = @client.delete('/delete', body: req)
 
     assert resp.http_response.instance_of?(Net::HTTPOK)
-    assert_equal MultiJson.load(resp.http_response.body, symbolize_keys: true)[:json], req
+    assert_equal MultiJson.load(resp.http_response.body,
+                                symbolize_keys: true)[:json], req
   end
 
   test 'headers are passed to request' do
-    h = { 'Some-Header' => 'some_value'}
-    resp = @client.get( '/headers', {header: h} )
+    h = { 'Some-Header' => 'some_value' }
+    resp = @client.get('/headers', header: h)
 
     assert resp.http_response.instance_of?(Net::HTTPOK)
-    assert_equal MultiJson.load(resp.http_response.body)['headers']['Some-Header'], 'some_value'
+
+    header = MultiJson.load(resp.http_response.body)['headers']['Some-Header']
+    assert_equal header, 'some_value'
   end
 
   test 'default headers are passed to request' do
-    h = { 'Some-Header' => 'some_value'}
-    resp = XSR::Client.new(header: h).get( 'https://httpbin.org/headers' )
+    h = { 'Some-Header' => 'some_value' }
+    resp = XSR::Client.new(header: h).get('https://httpbin.org/headers')
 
     assert resp.http_response.instance_of?(Net::HTTPOK)
-    assert_equal MultiJson.load(resp.http_response.body)['headers']['Some-Header'], 'some_value'
+
+    header = MultiJson.load(resp.http_response.body)['headers']['Some-Header']
+    assert_equal header, 'some_value'
   end
 
   test 'query string arguments are passed to request' do
-    p = {some_arg: 'some_value'}
-    resp = @client.get( '/get', {args: p} )
+    p = { some_arg: 'some_value' }
+    resp = @client.get('/get', args: p)
+
     assert resp.http_response.instance_of?(Net::HTTPOK)
 
-    assert_equal MultiJson.load(resp.http_response.body)['args']['some_arg'], 'some_value'
+    argument = MultiJson.load(resp.http_response.body)['args']['some_arg']
+    assert_equal argument, 'some_value'
   end
 
   test 'https request' do
     resp = XSR::Client.new.get('https://httpbin.org/get')
-    
+
     assert resp.http_response.instance_of?(Net::HTTPOK)
   end
-end
+end

data/test/helper.rb

@@ -1,4 +1,4 @@
-if ENV["TRAVIS"]
-  require "codeclimate-test-reporter"
+if ENV['TRAVIS']
+  require 'codeclimate-test-reporter'
   CodeClimate::TestReporter.start
 end

data/test/response_test.rb

@@ -1,56 +1,69 @@
 require 'xsr'
 require_relative 'helper'
 
+# Tests for Response class
 module ResponseTest
   prepare do
-    @client = XSR::Client.new( base_url: 'http://httpbin.org' )
+    @client = XSR::Client.new(base_url: 'http://httpbin.org')
   end
 
-  test "status 200 is a successful response" do
+  test 'status 200 gets a successful response' do
     res = @client.get('/status/200')
     assert res.success?
   end
 
-  test "status 201 is a successful response" do
+  test 'status 201 gets a successful response' do
     res = @client.get('/status/201')
     assert res.success?
   end
 
-  test "status 202 is a successful response" do
+  test 'status 202 gets a successful response' do
     res = @client.get('/status/202')
     assert res.success?
   end
 
-  test "status 400 is a successful response" do
+  test 'status 400 gets a Bad Request response' do
     res = @client.get('/status/400')
     assert !res.success?
     assert res.bad_request?
   end
 
-  test "status 404 is a successful response" do
+  test 'status 401 gets an Unauthorized response' do
+    res = @client.get('/status/401')
+    assert !res.success?
+    assert res.unauthorized?
+  end
+
+  test 'status 403 gets a Forbidden response' do
+    res = @client.get('/status/403')
+    assert !res.success?
+    assert res.forbidden?
+  end
+
+  test 'status 404 gets a Not Found response' do
     res = @client.get('/status/404')
     assert !res.success?
     assert res.not_found?
   end
 
-  test "status 500 is a successful response" do
+  test 'status 500 gets a Server Error response' do
     res = @client.get('/status/500')
     assert !res.success?
     assert res.server_error?
   end
 
-  test "simple json response" do
-    req = {some_attrib: 'some_value'}
+  test 'simple json response' do
+    req = { some_attrib: 'some_value' }
     res = @client.post('/post', body: req)
-    
+
     assert res.success?
     assert_equal res.body[:json], req
   end
 
-  test "json response with nested attributes" do
-    req = {something: {some_attrib: 'some_value'}}
+  test 'json response with nested attributes' do
+    req = { something: { some_attrib: 'some_value' } }
     res = @client.post('/post', body: req)
-    
+
     assert res.success?
     assert_equal res.body[:json], req
   end

data/xsr.gemspec

@@ -1,15 +1,15 @@
 Gem::Specification.new do |s|
   s.name        = 'xsr'
-  s.version     = '1.2.2'
-  s.summary     = "XSR: eXtremely Simple REST Client"
-  s.description = "A very simple library to talk to a REST/JSON API"
-  s.authors     = ["matiasow"]
+  s.version     = '1.3.0'
+  s.summary     = 'XSR: eXtremely Simple REST Client'
+  s.description = 'A very simple library to talk to a REST/JSON API'
+  s.authors     = ['matiasow']
   s.email       = ['matiasow@gmail.com']
   s.homepage    = 'http://github.com/matiasow/xsr'
   s.license     = 'MIT'
 
   s.files       =  `git ls-files`.split("\n")
 
-  s.add_dependency "multi_json", '~> 1.11', '>= 1.11.0'
-  s.add_development_dependency "cutest", '~> 1.2', '>= 1.2.2'
+  s.add_dependency 'multi_json', '~> 1.11', '>= 1.11.0'
+  s.add_development_dependency 'cutest', '~> 1.2', '>= 1.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xsr
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - matiasow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json