restclient_communicator

RestclientCommunicator

Hilfsklasse zur Kommunikation mit der Gem rest_client

Installation

Add this line to your application's Gemfile:

gem 'restclient_communicator',:git => 'https://github.com/olafkaderka/restclient_communicator.git', :branch => 'master'

And then execute:

$ bundle

Or install it yourself as:

$ gem install restclient_communicator

Usage

new_connect = RestclientCommunicator::Communication.new(url)

Das object new_connect hat dann folgende attribute:

• :errorcode
• :response,
• :http_code,
• :body,
• :options

Vom Prinzip ist bei einem erfolgreichen :get

• new_connect.errorcode.nil?
• new_connect.body => das ergebnis was man weiter verbeiten kann zb mit JSON.parse(new_connect.body)
• if new_connect.errorcode.nil? and body = new_connect.body ....

Es werden zahlreiche Fehler abgefangen und man kann das Verhalten auch ändern durch optionen die man als Hash übergeben kann. Folgende Werte sind automatisch gesetzt:

• :method => :get
• :open_timeout => 5
• :read_timeout => 5,
• :max_redirects => 1 (#for result codes 301, 302 or 307, the redirection will be followed if the request is a GET or a HEAD)

Es werdenn alle Werte die als Hash übergeben werden 1:1 an die Funktion RestClient::Request.execute weitergeben siehe rest_client So kann man u.a. auch Authorierungs parameter , Headerparameter etc übergeben.

new_connect = RestclientCommunicator::Communication.new(url, {:user => xxxx, :password => xxxx)

• Authorisierung (fals erforderlich)

new_connect = RestclientCommunicator::Communication.new(url, {:max_redirects => 0})

• bewirkt zb das bei einem 301,302, oder 307 nicht automatisch der neuen url gefolgt wird und ein Errorcode ausgegeben wird

new_connect = RestclientCommunicator::Communication.new(url, {:open_timeout => 1, :read_timeout => 30)

• bewirkt zb das bereits nach 1 Sekunde das timeout erreicht ist zum öffnen der Verbindung, aber erst nach 30 Sekunden der response

Weitere Funktionen siehe in des rspec Tests unter https://github.com/olafkaderka/restclient_communicator/blob/master/spec/restclient_communicator_spec.rb

Errorcodes

• "CE9901": Kommunikationsfehler Unauthorized
• "CE9902": Kommunikationsfehler Forbidden
• "CE9903": Kommunikationsfehler ImATeapot
• "CE9904": Kommunikationsfehler Not Found
• "CE9905": Kommunikationsfehler Timeout
• "CE9906": Kommunikationsfehler Broking Connection
• "CE9907": Kommunikationsfehler SSLCertificate nicht verifiziert
• "CE9908": Kommunikationsfehler PayloadTooLarge
• "CE9909": Kommunikationsfehler RequestURITooLong
• "CE9910": Kommunikationsfehler RequestedRangeNotSatisfiable
• "CE9999": Url Fehler

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/olafkaderka/restclient_communicator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the RestclientCommunicator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.