xsr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ee83ab8ac671bbbc63a6e1dd9fe9e1094617265
+  data.tar.gz: e33c6b188b742d4ceb395e3b14beba659579c3fb
+SHA512:
+  metadata.gz: 240808f43cef65593b98b4ada88f7970201929586c9485e2ea5d60a45dc06700413117f689295923d610f7cf99f3389a67a0c3433e6d2b8a5407a1f1e72701d9
+  data.tar.gz: a2398e4e935dad8f11c70f3203797ba292392312f084300e02351ce94c130fcfd944d8b7df8c7d2584feb5280a9cbd473cd1719e0960745104de5b586e07f8fc

data/.gitignore

@@ -0,0 +1,36 @@
+ .gitignore                                                                                                         
+*.gem
+*.gs
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/README.md

@@ -0,0 +1,104 @@
+# XSR - eXtremely Simple REST client
+
+XSR is an extremely simple REST client aimed to use against JSON/REST APIs.
+
+## Installation
+
+Simply run
+
+``` console
+$ gem install xsr
+```
+
+### Using Rails?
+
+Add the following line to your Gemfile:
+
+``` ruby
+gem 'xsr'
+```
+
+## Usage
+
+Create a new instance of XSR client specifying the base_url for wich you will be requesting further paths:
+
+``` ruby
+require 'xsr'
+client = XSR::Client.new
+```
+
+And then invoke a service:
+
+``` ruby
+resp = client.get('http://api.something.io')
+resp.success?
+#=> true
+resp.body
+#=> JSON response as a Ruby Hash Object
+```
+###Supported HTTP verbs
+Implemented verbs are GET, POST, PUT and DELETE. To change the verb simply invoke the corresponding method:
+####HTTP GET
+This will make a HTTP GET request to http://api.something.io
+``` ruby
+client.get('http://api.something.io')
+```
+####HTTP POST
+This will make a HTTP POST request to http://api.something.io
+``` ruby
+client.post('http://api.something.io')
+```
+####HTTP PUT
+This will make a HTTP PUT request to http://api.something.io
+``` ruby
+client.put('http://api.something.io')
+```
+####HTTP DELETE
+This will make a HTTP DELETE request to http://api.something.io
+``` ruby
+client.delete('http://api.something.io')
+```
+
+###Using query string arguments
+This will make a HTTP GET request to http://api.somthing.io?arg1=a&arg2=b
+``` ruby
+client.get('http://api.something.io', args: {arg1: 'a', arg2: 'b'})
+```
+
+###Passing JSON arguments in request body
+``` ruby
+req = { some_key: some_value, other_key: [1,2,3] }
+client.post('http://api.something.io', body: req)
+```
+
+###Using HTTP headers
+This will make a HTTP GET request to http://api.somthing.io passing 'Some-Header: Some-Value' in the HTTP headers
+``` ruby
+resp = client.get('http://api.something.io', header: {some_header: 'some_value'})
+```
+
+###Response object
+HTTP response comes in the form of a ```XSR::Response``` object:
+``` ruby
+resp = client.post('http://api.something.io')
+
+resp.success?
+#=> Response status code is 2xx
+
+resp.bad_request?
+#=> Response status code is 403
+
+resp.not_found?
+#=> Response status code is 404
+
+resp.server_error?
+#=> Response status code is 500
+
+resp.body
+#=> JSON response as a Ruby Hash object
+```
+
+##What's next?
+I'm not planning to add more features right now, but feel free to fork this repo and add any extra functionality you consider that should be included. Please, submit a PR with proposed changes or fixes.
+Just keep in mind a minimalist paradigm (https://youtu.be/tXVr2E1vfmk).
+

data/lib/xsr.rb

@@ -0,0 +1,7 @@
+require 'open-uri'
+require 'net/http'
+require 'multi_json'
+require 'openssl'
+
+require 'xsr/client'
+require 'xsr/response'

data/lib/xsr/client.rb

@@ -0,0 +1,52 @@
+module XSR
+  class Client
+    attr_accessor :base_url
+    attr_accessor :default_header
+
+    def initialize(options = {})
+      @base_url = options[:base_url]
+      @base_header = options[:header]
+    end
+
+    def post(path, options = {})
+      request_with_data(path, options) { |uri| Net::HTTP::Post.new(uri.to_s) }
+    end
+
+    def delete(path, options = {})
+      request_with_data(path, options) { |uri| Net::HTTP::Delete.new(uri.to_s) }
+    end
+
+    def put(path, options = {})
+      request_with_data(path, options) { |uri| Net::HTTP::Put.new(uri.to_s) }
+    end
+
+    def get(path, options = {})
+      request_with_data(path, options) { |uri| Net::HTTP::Get.new(uri.to_s) }
+    end
+
+  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 )
+
+      req = yield(uri)
+
+      # Set headers
+      req['Content-Type'] = 'application/json'
+      @base_header && @base_header.each{ |k,v| req[k] = v }
+      options[:header] && options[:header].each{ |k,v| req[k] = v }
+
+      # Set body
+      req.body = options[:body] && MultiJson.dump( options[:body] )
+
+      http_session = Net::HTTP.new(uri.host, uri.port)
+
+      if uri.scheme == 'https' # Requires SSL?
+        http_session.use_ssl = true
+        http_session.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      XSR::Response.new( http_session.start{ |http| http.request(req) } )
+    end
+  end
+end

data/lib/xsr/response.rb

@@ -0,0 +1,31 @@
+module XSR
+  class Response 
+    attr_reader :http_response
+
+    def initialize(http_response)
+      @http_response = http_response
+    end
+    
+    def success?
+      @http_response.is_a? Net::HTTPSuccess
+    end
+
+    def bad_request?
+      @http_response.is_a? Net::HTTPBadRequest
+    end
+
+    def not_found?
+      @http_response.is_a? Net::HTTPNotFound
+    end
+
+    def server_error?
+      @http_response.is_a? Net::HTTPServerError
+    end
+
+    def body
+      if self.success?
+        @http_response.body && MultiJson.load( @http_response.body, symbolize_keys: true )
+      end
+    end
+  end
+end

data/makefile

@@ -0,0 +1,5 @@
+.PHONY: test
+
+test:
+	@echo Running tests... && \
+	RUBYLIB=./lib cutest test/*_test.rb

data/test/client_test.rb

@@ -0,0 +1,68 @@
+require 'xsr'
+require_relative 'helper'
+
+module ClientTest
+  prepare do
+    @client = XSR::Client.new( base_url: 'http://httpbin.org' )
+  end
+
+  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} )
+    
+    assert resp.http_response.instance_of?(Net::HTTPOK)
+    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} )
+
+    assert resp.http_response.instance_of?(Net::HTTPOK)
+    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} )
+
+    assert resp.http_response.instance_of?(Net::HTTPOK)
+    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} )
+
+    assert resp.http_response.instance_of?(Net::HTTPOK)
+    assert_equal MultiJson.load(resp.http_response.body)['headers']['Some-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' )
+
+    assert resp.http_response.instance_of?(Net::HTTPOK)
+    assert_equal MultiJson.load(resp.http_response.body)['headers']['Some-Header'], 'some_value'
+  end
+
+  test 'query string arguments are passed to request' do
+    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'
+  end
+
+  test 'https request' do
+    resp = XSR::Client.new.get('https://httpbin.org/get')
+    
+    assert resp.http_response.instance_of?(Net::HTTPOK)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'securerandom'
+
+def random_hash
+  {SecureRandom.hex => SecureRandom.hex} 
+end
+

data/test/response_test.rb

@@ -0,0 +1,57 @@
+require 'xsr'
+require_relative 'helper'
+
+module ResponseTest
+  prepare do
+    @client = XSR::Client.new( base_url: 'http://httpbin.org' )
+  end
+
+  test "status 200 is a successful response" do
+    resp = @client.get('/status/200')
+    assert resp.success?
+  end
+
+  test "status 201 is a successful response" do
+    resp = @client.get('/status/201')
+    assert resp.success?
+  end
+
+  test "status 202 is a successful response" do
+    resp = @client.get('/status/202')
+    assert resp.success?
+  end
+
+  test "status 400 is a successful response" do
+    resp = @client.get('/status/400')
+    assert !resp.success?
+    assert resp.bad_request?
+  end
+
+  test "status 404 is a successful response" do
+    resp = @client.get('/status/404')
+    assert !resp.success?
+    assert resp.not_found?
+  end
+
+  test "status 500 is a successful response" do
+    resp = @client.get('/status/500')
+    assert !resp.success?
+    assert resp.server_error?
+  end
+
+  test "simple body" do
+    req = {some_attrib: 'some_value'}
+    resp = @client.post('/post', body: req)
+    
+    assert resp.success?
+    assert_equal resp.body[:json], req
+  end
+
+  test "body with nested attributes" do
+    req = {something: {some_attrib: 'some_value'}}
+    resp = @client.post('/post', body: req)
+    
+    assert resp.success?
+    assert_equal resp.body[:json], req
+  end
+end

data/xsr.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'xsr'
+  s.version     = '1.0.0'
+  s.summary     = "XSR: eXtremely Simple REST Client"
+  s.description = "A very simple library to talk to a REST/JSON API"
+  s.authors     = ["Matias Owsianik"]
+  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"
+  s.add_development_dependency "cutest"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: xsr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matias Owsianik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_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
+  name: cutest
+  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 very simple library to talk to a REST/JSON API
+email:
+- matiasow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- lib/xsr.rb
+- lib/xsr/client.rb
+- lib/xsr/response.rb
+- makefile
+- test/client_test.rb
+- test/helper.rb
+- test/response_test.rb
+- xsr.gemspec
+homepage: http://github.com/matiasow/xsr
+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.5
+signing_key: 
+specification_version: 4
+summary: 'XSR: eXtremely Simple REST Client'
+test_files: []