resource_accessor 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjBlYjg5ZDZiZTU1ZjRhYjBjNDJiODQyYWNlYzU3MGUyNGU2NWQ4Zg==
-  data.tar.gz: !binary |-
-    OTlmNmYxN2IyMDk0YzY3NDFlNDJlNDg3YWVkZGRmMzllYjljMDE3YQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NTMwYmNlMGNkYzg1NWU5ZTFiZTk0ZGViZGYwY2U3ZjU5OTAzNTk0MDYxOWMx
-    MWFlYjgyZTA3MmM4OWRiZTcyYmIwZTI1OWUwYjliZDZhNTc3YzE2NTZmNTQ4
-    Y2IzNWFlNjUzNGMzZDdkMmM5YzM4NmI2MDc2MDU4N2NkZTZmOTk=
-  data.tar.gz: !binary |-
-    Y2ExNDE5NGI3YWQ4NDkxMGJmZDBiZTVlMTFmY2M1ODk1NDk3Y2VhMDMzMjZi
-    MGUwOGJkMzBjMzAxNzNjOTA2ZTQ0YzliZjM4MjNiMGMyMzBkOGRiODEyZGUx
-    MTFiNjEwMzU5ZTliZjBjZjcyZmViYTQyMWQ0NzI0NmQyOWI2Yjk=
+SHA1:
+  metadata.gz: 32baacfc4e7a916204597ea8d1f6241e56c38807
+  data.tar.gz: a1994c6edd8045267b9ab688cf658edcd70bec12
+SHA512:
+  metadata.gz: afb238c1736db16a20a52b995b789bff9a3fbdc0989ecd174607972584ee87903d3071f0e5fcf69bbd22b7f49be2f8c456be6593f64aa075ac0c61c5e634acbe
+  data.tar.gz: b9e1d3c2f7069b857d86e9d4d4dbe42000055c79dc7344f3871df29ce5f5ddfc05709ca8d449b7362e80e727800bbccf631e08eb7ec431e6ae1f1c7da5678026

data/.ruby-gemset

@@ -0,0 +1 @@
+resource_accessor

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/CHANGES

@@ -6,4 +6,8 @@
 
 == Version 1.0.1
 
-* Bug fix.
+* Bug fix.
+
+== Version 1.1.0
+
+* Write documentation;API change.

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 group :development do
   gem "gemspec_deps_gen"
@@ -7,7 +7,5 @@ end
 
 group :test do
   gem "rspec"
-  gem "rspec-core"
-  gem "rspec-expectations"
   gem "mocha"
 end

data/Gemfile.lock

@@ -1,22 +1,23 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
-    file_utils (1.0.6)
+    diff-lcs (1.2.4)
+    file_utils (1.0.7)
     gemcutter (0.7.1)
-    gemspec_deps_gen (1.0.5)
+    gemspec_deps_gen (1.1.2)
+      bundler
       file_utils
     metaclass (0.0.1)
-    mocha (0.13.2)
+    mocha (0.14.0)
       metaclass (~> 0.0.1)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
 
 PLATFORMS
   ruby
@@ -26,5 +27,3 @@ DEPENDENCIES
   gemspec_deps_gen
   mocha
   rspec
-  rspec-core
-  rspec-expectations

data/README.md

@@ -12,41 +12,77 @@ And then execute:
 
 ## Usage
 
+Create accessor object:
+
 ```ruby
-    require 'resource_accessor'
+require 'resource_accessor'
+
+accessor = ResourceAccessor.new
+```
+
+If you want to access unprotected resource located at **some_url**:
 
-    accessor = ResourceAccessor.new
+```ruby
+response = accessor.get_response :url => some_url
+```
 
-    # to get unprotected resource
-    response = accessor.get_response :url => some_url
+If you want to get protected resource, first get a cookie and then access protected resource:
 
-    # to get cookie
-    cookie = accessor.get_cookie login_url, user_name, password
+```ruby
+# 1. Get cookie
 
-    # to get protected resource through POST and post body as hash
-    response = accessor.get_response :url => some_url, :method => :post, :cookie => cookie,
-                                    :body => some_hash
+cookie = accessor.get_cookie login_url, user_name, password
 
-    # to get protected resource through POST and post body as string
-    response = accessor.get_response :url => some_url, :method => :post, :cookie => cookie,
-                                    :body => some_string
+# 2.a. Get protected resource through POST and post body as hash
 
-    # to get AJAX resource
-    response = accessor.get_ajax_response :url => some_url
-    # or
-    response = accessor.get_response {:url => some_url}, {'X-Requested-With' => 'XMLHttpRequest'}
+response = accessor.get_response :url => some_url, :method => :post, :cookie => cookie,
+                                 :body => some_hash
 
-    # to get SOAP resource
-    response = accessor.get_soap_response :url => some_url
-    # or
-    response = accessor.get_response {:url => some_url}, {'SOAPAction' => 'someSoapOperation', 'Content-Type' => 'text/xml;charset=UTF-8'}
+# 2.b. Get protected resource through POST and post body as string
 
-    # to get JSON resource
-    response = accessor.get_response {:url => some_url}, {'Content-Type" => "application/json;charset=UTF-'}
+response = accessor.get_response :url => some_url, :method => :post, :cookie => cookie,
+                                 :body => some_string
+```
+You have to specify HTTP method explicitly here (post).
 
+If you want to get AJAX resource, add special header to the request or use special method:
+
+```ruby
+response1 = accessor.get_response {:url => some_url}, {'X-Requested-With' => 'XMLHttpRequest'}
+
+response2 = accessor.get_ajax_response :url => some_url
+```
+
+If you want to get SOAP resource, same as before, add special header to the request or use special method:
+
+```ruby
+response1 = accessor.get_response {:url => some_url}, {'SOAPAction' => 'someSoapOperation', 'Content-Type' => 'text/xml;charset=UTF-8'}
 
+response2 = accessor.get_soap_response :url => some_url
 ```
 
+If you want to get JSON resource, same as before, add special header to the request or use special method:
+
+```ruby
+response = accessor.get_response {:url => some_url}, {'Content-Type" => "application/json;charset=UTF-8'}
+
+response2 = accessor.get_json_response :url => some_url
+```
+
+You can setup timeout for your accessor object in milliseconds:
+
+```ruby
+accessor.timeout = 10000
+```
+
+If you need to work over ssl enable certificate validation before the call:
+
+```ruby
+accessor.validate_ssl_cert = true
+accessor.ca_file = 'your cert file location'
+```
+
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -6,20 +6,16 @@ require "rspec/core/rake_task"
 require "resource_accessor/version"
 require "gemspec_deps_gen/gemspec_deps_gen"
 
-def version
-  ResourceAccessor::VERSION
-end
-
-def project_name
-  File.basename(Dir.pwd)
-end
+version = ResourceAccessor::VERSION
+project_name = File.basename(Dir.pwd)
 
-task :build do
-  system "rm #{project_name}.gemspec"
+task :gen do
   generator = GemspecDepsGen.new
 
-  generator.generate_dependencies "#{project_name}.gemspec.erb", "#{project_name}.gemspec"
+  generator.generate_dependencies "spec", "#{project_name}.gemspec.erb", "#{project_name}.gemspec"
+end
 
+task :build => :gen do
   system "gem build #{project_name}.gemspec"
 end
 
@@ -27,6 +23,10 @@ task :install do
   system "gem install #{project_name}-#{version}.gem"
 end
 
+task :uninstall do
+  system "gem uninstall #{project_name}"
+end
+
 task :release => :build do
   system "gem push #{project_name}-#{version}.gem"
 end
@@ -35,3 +35,4 @@ RSpec::Core::RakeTask.new do |task|
   task.pattern = 'spec/**/*_spec.rb'
   task.verbose = false
 end
+

data/lib/resource_accessor/resource_accessor.rb

@@ -1,9 +1,13 @@
 require 'net/https'
 
-require 'system_timer' if RUBY_VERSION.to_f < 1.9 and RUBY_PLATFORM != 'java'
-
 class ResourceAccessor
-  include SystemTimer if RUBY_VERSION.to_f < 1.9 and RUBY_PLATFORM != 'java'
+  attr_accessor :timeout, :ca_file, :validate_ssl_cert
+
+  def initialize timeout = 10000, ca_file = nil, validate_ssl_cert = false
+    @timeout = timeout
+    @ca_file = ca_file
+    @validate_ssl_cert = validate_ssl_cert
+  end
 
   def get_response params, headers = {}
     locate_response(params[:url], params[:method], headers, params[:body], params[:cookie])
@@ -23,6 +27,12 @@ class ResourceAccessor
     locate_response(params[:url], params[:method], headers, params[:body], params[:cookie])
   end
 
+  def get_json_response params, headers = {}
+    headers["Content-Type"] = "application/json;charset=UTF-8"
+
+    locate_response(params[:url], params[:method], headers, params[:body], params[:cookie])
+  end
+
   def get_cookie url, user_name, password
     headers = {"Content-Type" => "application/x-www-form-urlencoded; charset=UTF-8"}
 
@@ -85,25 +95,16 @@ class ResourceAccessor
       request = Net::HTTP::Get.new(uri.request_uri, headers)
     end
 
-    connection.read_timeout = timeout()
-    connection.open_timeout = timeout()
-
-    timeout_class = defined?(SystemTimer) ? SystemTimer : Timeout
+    connection.read_timeout = timeout
+    connection.open_timeout = timeout
 
-    timeout_class.timeout(timeout) do
+    Timeout.timeout(timeout) do
       return connection.request(request)
     end
   end
 
   def validate_ssl_cert?
-    false
+    validate_ssl_cert
   end
 
-  def ca_file
-    nil
-  end
-
-  def timeout
-    10000
-  end
 end

data/lib/resource_accessor/version.rb

@@ -1,3 +1,3 @@
 class ResourceAccessor
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/resource_accessor.gemspec

@@ -14,9 +14,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   spec.version       = ResourceAccessor::VERSION
+  spec.license       = "MIT"
 
+  
   spec.add_development_dependency "gemspec_deps_gen", [">= 0"]
   spec.add_development_dependency "gemcutter", [">= 0"]
-  
+
 end
 

data/resource_accessor.gemspec.erb

@@ -14,7 +14,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   spec.version       = ResourceAccessor::VERSION
+  spec.license       = "MIT"
 
-  <%= include_dependencies %>
+  <%= project_dependencies %>
 end
 

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: resource_accessor
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexander Shvets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemspec_deps_gen
   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: gemcutter
   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: This library is used to simplify access to protected or unprotected http
@@ -48,7 +48,8 @@ files:
 - .gitignore
 - .idea/dictionaries/alex.xml
 - .idea/scopes/scope_settings.xml
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - CHANGES
 - Gemfile
 - Gemfile.lock
@@ -63,7 +64,8 @@ files:
 - spec/resource_accessor_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/shvets/resource_accessor
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -71,12 +73,12 @@ 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: []

data/.rvmrc

@@ -1,4 +0,0 @@
-rvm_gemset_create_on_use_flag=1
-rvm_pretty_print_flag=1
-
-rvm use ruby-1.9.3@resource_accessor