arest 0.9.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 486926dcce7e504ad5fd10ddc6eb66495681fad1
+  data.tar.gz: 42a53c28a548b74d049f4cfa9c0fafb32b0de8cb
+SHA512:
+  metadata.gz: 5ce9be9ec6c7302033c4b04e9e5ddf3ec815258d0b11a7607833089eeae91e78e790bb89e01b2b27e6543ac6bf2c704f67d41140be8a3a37023036c0e7f934a8
+  data.tar.gz: 92b431e715d1c731dbc42b84c0d551b83ee50dcd15cc83bbef49242b283757c5945062cc0f394e263802ce0577c8048f317697c3481c97528904bcebc5641f06

data/lib/arest.rb

@@ -0,0 +1,123 @@
+require 'json'
+require 'net/http'
+require 'active_support/core_ext/hash/conversions'
+
+# Extensions to standard HTTPResponse
+class Net::HTTPResponse
+  # Find out the content type of the response and convert it the proper object
+  def deserialize
+    case content_type
+    when "application/xml"
+      Hash.from_xml body
+    when "application/json"
+      JSON.parse body
+    else
+      body
+    end
+  end
+
+  # True if response is HTTP OK
+  def ok?
+    Net::HTTPSuccess === self || Net::HTTPRedirection === self
+  end
+end
+
+class ARestException < Exception; end
+
+class ARest
+  # Input:
+  # * base_url - the base URL for REST API
+  #
+  # Options:
+  # * headers (Hash) to set up headers
+  #   c = ARest.new "http://localhost:3000/_api/v1", headers: {"Authentication" => "Token token=AHDIUHSBC...."}
+  #
+  # * username and password for basic http authentication
+  #   c = ARest.new "http://localhost:3000/_api/v1", username: "user1", password: "password.8"
+  # 
+  # * Authentication token
+  #   c = ARest.new "http://localhost:3000/_api/v1", token: 'AdbsuUDhwb3hqhj...'
+  def initialize(base_url, **options)
+    @base_url = base_url
+    @headers = options[:headers]
+    @auth_user = options[:username]
+    @auth_password = options[:password]
+    @auth_token = options[:token]
+  end
+
+  # Perform a HTTP GET request. Requires a path to current operation
+  # See #execute for details
+  def get(path, **options)
+    execute :get, path, options
+  end
+
+  # Perform a HTTP POST request. Requires a path to current operation
+  # See #execute for details
+  def post(path, **options)
+    execute :post, path, options
+  end
+
+  # Perform a HTTP PUT request. Requires a path to current operation
+  # See #execute for details
+  def put(path, **options)
+    execute :put, path, options
+  end
+
+  # Perform a HTTP DELETE request. Requires a path to current operation
+  # See #execute for details
+  def delete(path, **options)
+    execute :delete, path, options
+  end
+
+  def inspect
+    "<ARest #{@base_url}#{if @headers then ', with headers' else '' end}#{if @auth_user && @auth_password then ', authenticating as '+@auth_user else '' end}>"
+  end
+
+  private
+  # Perform a HTTP request. Requires method name a path to current operation. 
+  # If given, headers and http authentication can be override
+  #
+  # Input
+  # * method - HTTP method, :get, :post, :delete, :header, :update
+  # * path - relative to URI given in constructor
+  # Options Hash
+  # * headers - overrides the header given in constructor
+  # * username, password - overrides the http authentication
+  # * token - overrides authorization token
+  # * form_data - hash with HTML form data
+  def execute(method, path, **options)
+    uri = URI("#{@base_url}/#{path}")
+
+    case method.to_sym
+    when :get
+      req = Net::HTTP::Get.new(uri)
+    when :post
+      req = Net::HTTP::Post.new(uri)
+    when :put
+      req = Net::HTTP::Put.new(uri)
+    when :delete
+      req = Net::HTTP::Delete.new(uri)
+    else
+      raise ARestException, "Unknown method: #{method}"
+    end
+
+    req.form_data = options[:form_data] if options[:form_data]
+
+    headers = options[:headers] || @headers 
+    headers.each { |k,v| req[k] = v } if headers
+
+    auth_user = options[:auth_user] || @auth_user
+    auth_password = options[:auth_password] || @auth_password
+    req.basic_auth auth_user, auth_password if auth_user && auth_password
+
+    token = options[:token] || @auth_token
+    if token
+      req["Authorization"] = "Token token=#{token}"
+    end
+
+    res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      http.request(req)
+    end
+    res
+  end
+end

data/spec/arest_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+describe ARest do
+  describe "JSON request" do
+    describe "without authentication" do
+      before do
+        @client = ARest.new 'http://jsonplaceholder.typicode.com'
+      end
+      it "should be able to get fake users list" do
+        users_res = @client.get 'users'
+        expect(users_res).to be_ok
+        users = users_res.deserialize
+        expect(users.count).to eq 10
+      end
+      it "should be able to GET fake user" do
+        user = @client.get('users/1').deserialize
+        expect(user["name"]).to eq "Leanne Graham"
+      end
+      it "should be able to POST fake post" do
+        posts_res = @client.post('posts', form_data: { title: 'foo', body: 'bar', userId: 1 })
+        expect(posts_res).to be_ok
+        post = posts_res.deserialize
+        expect(post['title']).to eq 'foo'
+      end
+      it "should be able to PUT fake post" do
+        posts_res = @client.put('posts/1', form_data: { id: 1, title: 'foo', body: 'bar', userId: 1 })
+        expect(posts_res).to be_ok
+        post = posts_res.deserialize
+        expect(post['title']).to eq 'foo'
+      end
+      it "should be able to DELETE fake post" do
+        posts_res = @client.delete('posts/1')
+        expect(posts_res).to be_ok
+      end
+    end
+
+    describe "with HTTP authentication" do
+      # to test authentication I use the demo of Tarkin, The Team Password Manager
+      before do
+        @arest = ARest.new 'http://tarkin.tg.pl/_api/v1', username: 'user@example.com', password: 'password0'
+      end
+      it "should be able to login with http authentication" do
+        res = @arest.get '_authorize.json'
+        expect(res).to be_ok
+      end
+      it "should be able to get password" do
+        pass = @arest.get('/db/prod/oracle/scott').deserialize
+        expect(pass).to eq 't1ger'
+      end
+    end
+
+    describe "with form authentication" do
+      before do
+        @arest = ARest.new 'http://tarkin.tg.pl/_api/v1'
+      end
+      it "should be able to get password with form authentication" do
+        pass = @arest.post('/db/prod/oracle/scott.json', form_data: { email: 'user@example.com', password: 'password0'}).deserialize
+        expect(pass['password']).to eq 't1ger'
+      end
+    end
+
+    describe "with token authentication" do
+      before do
+        auth = ARest.new 'http://tarkin.tg.pl/_api/v1', username: 'user@example.com', password: 'password0'
+        token = auth.get('_authorize').deserialize
+        @arest = ARest.new 'http://tarkin.tg.pl/_api/v1', token: token
+      end
+      it "should be able to get password" do
+        pass = @arest.get('/db/prod/oracle/scott').deserialize
+        expect(pass).to eq 't1ger'
+      end
+    end
+  end
+
+  describe "XML request" do
+    describe "without authentication" do
+      before do
+        @client = ARest.new 'http://www.thomas-bayer.com/sqlrest'
+      end
+      it "should be able to get the fake customer" do 
+        customer = @client.get('CUSTOMER/3').deserialize['CUSTOMER']
+        expect(customer['FIRSTNAME']).to eq "Michael"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'arest'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: arest
+version: !ruby/object:Gem::Version
+  version: 0.9.1.0
+platform: ruby
+authors:
+- Tomek Gryszkiewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A Very Simple REST client
+email: grych@tg.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/arest.rb
+- spec/arest_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/grych/arest
+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: A REST client
+test_files:
+- spec/arest_spec.rb
+- spec/spec_helper.rb