restclient_communicator 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e37da0912daf6fb6c5e5b3e4afe2d4ba7e35bb12
+  data.tar.gz: 5f752e7740716b1ac3e66d405f896d22267ab31a
+SHA512:
+  metadata.gz: d2974c06eb13034ca26e4357602172c9d646d9d2ddb618f11cb9b9461db02b6c3a954367395eaf11a6c3ce605556a1208365d30f9552bcbe972edb02907afb57
+  data.tar.gz: 154ccc67aec122bba45240f84b11c11656aa4f3a8b735f3256c729b756655c10505456f5f213099ceece74264ad0cd8660adbe982bfd811611a19a776802de0f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in restclient_communicator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# RestclientCommunicator
+
+Hilfsklasse zur Kommunikation mit der Gem [rest_client](https://github.com/rest-client/rest-client)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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](https://github.com/rest-client/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](https://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](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## 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](https://github.com/olafkaderka/restclient_communicator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "restclient_communicator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/restclient_communicator.rb

@@ -0,0 +1,129 @@
+require "restclient_communicator/version"
+require 'active_support'
+require 'active_support/core_ext'
+require 'addressable'
+require 'rest_client'
+
+module RestclientCommunicator
+  # Your code goes here...
+  class Communication
+
+    attr_accessor :errorcode, :response, :http_code, :body, :options, :file
+
+    VALID_SCHEMES = ["http","https"]
+
+    def initialize(url, options={})
+      return if url.blank?
+      default_options = {
+        :method => :get,
+        :open_timeout => 5,
+        :read_timeout => 5,
+        :max_redirects => 1,
+        :raw_response => false,
+      }
+      @options = options.reverse_merge(default_options)
+      @errorcode, @response, @http_code, @body, @file = nil
+      self.check_url(url)
+    end
+
+    def check_url(url)
+      begin
+
+        new_url = Addressable::URI.parse(url)
+        #muss ich jetztz bereinigen, da dieser wert 1:1 an restclient geht
+        if new_url
+
+          if !VALID_SCHEMES.include? new_url.scheme
+            @errorcode = "CE9991"
+            return
+          end
+
+          options[:url] = new_url.normalize.to_str
+          self.start 
+        else
+          @errorcode = "CE9993"
+        end
+      rescue Addressable::URI::TypeError, Addressable::URI::NoMethodError, Addressable::URI::InvalidURIError => e
+        @errorcode = "CE9999"
+      end
+    end
+
+    def start     
+      begin
+      
+
+
+        #for result codes between 200 and 207, a RestClient::Response will be returned
+        #for result codes 301, 302 or 307, the redirection will be followed if the request is a GET or a HEAD
+        #for result code 303, the redirection will be followed and the request transformed into a GET
+        #for other cases, a RestClient::ExceptionWithResponse holding the Response will be raised; a specific exception class will be thrown for known error codes
+        #call .response on the exception to get the server's response       
+        @response = RestClient::Request.execute(**@options)
+        @http_code = @response.code
+        case @http_code
+        when 200,207
+          
+          #https://github.com/rest-client/rest-client/blob/master/lib/restclient/raw_response.rb
+          #In addition, if you do not use the response as a string, you can access
+          #a Tempfile object at res.file, which contains the path to the raw
+          #downloaded request body.
+          if @options[:raw_response]
+            @file = @response.file
+          else
+            @body = @response.body
+          end
+        else
+          case @options[:method]
+          when :get, :head
+            #bei get wird automatisch einem redirect gefolgt
+            #For GET and HEAD requests, rest-client automatically follows redirection.
+            case @http_code
+            when 301,302,307
+              @body = @response.body
+            end
+          when :post 
+            case @http_code
+            when 301, 302, 307
+              @response.follow_redirection
+            end
+          end 
+        end
+      rescue RestClient::MovedPermanently, RestClient::Found, RestClient::TemporaryRedirect => e
+        @response = e.response
+        @http_code = @response.code
+        @errorcode = "CE9920" if @options[:max_redirects] == 0
+        #case @options[:method]
+        #when :post
+        #todo das ist nich nicht so oaky
+        #e.response.follow_redirection
+      rescue RestClient::Unauthorized => e
+        @http_code = e.response.code
+        @errorcode = "CE9901"
+      rescue RestClient::Forbidden  => e
+        @http_code = e.response.code
+        @errorcode = "CE9902"
+      rescue RestClient::ImATeapot => e
+        @http_code = e.response.code
+        @errorcode = "CE9903"
+      rescue RestClient::NotFound => e
+        @http_code = e.response.code
+        @errorcode = "CE9904"
+      rescue RestClient::Exceptions::Timeout => e
+        #könnte man auch noch unterscheiden RestClient::Exceptions::Timeout::OpenTimeout, RestClient::Exceptions::Timeout::ReadTimeout
+        #https://github.com/rest-client/rest-client/blob/master/lib/restclient/exceptions.rb
+        @errorcode = "CE9905"
+      rescue RestClient::ServerBrokeConnection  => e
+        @errorcode = "CE9906"
+      rescue RestClient::SSLCertificateNotVerified => e
+        @errorcode = "CE9907"
+      rescue RestClient::PayloadTooLarge => e
+        @errorcode = "CE9908"
+        @http_code = e.response.code
+      rescue RestClient::RequestURITooLong => e
+        @errorcode = "CE9909" 
+      rescue RestClient::RequestedRangeNotSatisfiable => e
+        @errorcode = "CE9910"      
+      end
+    end
+  end
+end

data/lib/restclient_communicator/version.rb

@@ -0,0 +1,3 @@
+module RestclientCommunicator
+  VERSION = "0.2.0"
+end

data/restclient_communicator.gemspec

@@ -0,0 +1,48 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "restclient_communicator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "restclient_communicator"
+  spec.version       = RestclientCommunicator::VERSION
+  spec.authors       = ["Olaf Kaderka"]
+  spec.email         = ["okaderka@yahoo.de"]
+
+  spec.summary       = %q{Hilfsklasse für die Kommunikation ueber RestClient}
+  spec.description   = %q{Gibt nicht viel mehr darüber zu erzaehlen}
+  spec.homepage      = "https://github.com/olafkaderka/restclient_communicator"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+
+  #communication
+  #fuer sauber uris https://github.com/sporkmonger/addressable
+  spec.add_dependency "addressable"
+
+  #for mattr_accessor, reverse_merge
+  spec.add_dependency "activesupport", '>= 4.0'
+
+  #https://github.com/rest-client/rest-client
+  spec.add_dependency "rest-client"
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: restclient_communicator
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Olaf Kaderka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+description: Gibt nicht viel mehr darüber zu erzaehlen
+email:
+- okaderka@yahoo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/restclient_communicator.rb
+- lib/restclient_communicator/version.rb
+- restclient_communicator.gemspec
+homepage: https://github.com/olafkaderka/restclient_communicator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Hilfsklasse für die Kommunikation ueber RestClient
+test_files: []