ereignishorizont-client 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4d35076e57d1e659220bf2f0a67b46eb7b33196
+  data.tar.gz: 097716efefcd1baa5b29aa96897cad0f1f85252a
+SHA512:
+  metadata.gz: 4b9980bebcdeec1eb2f0b5a539fc9ba372ab2cb706ab7fe12e602ac686df5b4571789fc61a7cdc2a7ab9ff3479f764a1b5b8cfaabab9cf6d4ab2a9c57dee4e46
+  data.tar.gz: 2963fbd34d9ed7bc9ba450aa23e90843f9bd6fdafe1346f2a94474fb48e87266f93b6c031a12b95e21833ab225d66efa85c24deb0c5dc365e5bc2b01e251f52a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+event_girl_client

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.2.2
+- 2.3.0
+script: bundle exec rspec spec
+notifications:
+  email:
+  - tam.eastley@gmail.com
+  - susanne.dewein@gmail.com
+  - felix@mohnert.de
+  webhooks:
+    secure: YgIzmRfVkBhyjLeEhtnGuZ4s0J3jw1jBxrP0qh6VLx+I2bGszuv1VJAAKhhUmqXi5qyAaOeNRKYmwE1UN8P6UupmtNpxBPpki+tzZ07rHkNqC9EkCg2NgzhcNV654XjXQNEyUb4I54bpbMbQXa+aX3RokfuxWR4ernb61TelwjU=

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## v1.2.0
+- Fix openssl requirement
+
+## v1.2.0
+- Add support for optional content parameter
+- EventGirl::Client.send_event is deprecated, use #send! instead
+- Allows setting the url to protocol + hostname only, w/o path
+
+## v1.1.1
+- Adds SSL-support
+
+## v1.1.0
+- Fix Ruby 1.9.3 issues
+- Removed ActiveSupport dependency
+- Add ``--debug`` option for cmd line tool

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+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. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in event_girl_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Absolventa GmbH, Susanne Dewein, Tam Eastley
+
+MIT License
+
+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,59 @@
+# Ereignishorizont Client [![Code Climate](https://codeclimate.com/github/Absolventa/ereignishorizont-client.png)](https://codeclimate.com/github/Absolventa/ereignishorizont-client) [![Build Status](https://travis-ci.org/Absolventa/ereignishorizont-client.png?branch=master)](https://travis-ci.org/Absolventa/ereignishorizont-client) [![Gem Version](https://badge.fury.io/rb/ereignishorizont.png)](http://badge.fury.io/rb/ereignishorizont)
+
+Ereignishorizont Client can be used in your own app to send
+events to an external Ereignishorizont Application such as
+[ereignishorizont.herokuapp.com](https://ereignishorizont.herokuapp.com).
+It is the gem for [Ereignishorizont](https://github.com/Absolventa/ereignishorizont)
+(formerly known as 'Event Girl') which was part of a project
+for the [Rails Girls Summer of Code](http://railsgirlssummerofcode.org).
+Its three main contributors are the
+Rails Girls Susanne and Tam, and their coach Carsten, who worked on the project
+from July 2 - September 30, 2013 at the [ABSOLVENTA](https://www.absolventa.de)
+offices in Berlin.
+
+Using an initializer file for Rails, you can do:
+
+    Ereignishorizont::Client.configure do |config|
+      config.api_token = 'my-api-token'
+      config.url = 'http://my-ereignishorizont-endpoint.example.com'
+    end
+
+The gem also includes a command line executable. See ``ereignishorizont -h`` for further details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ereignishorizont-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ereignishorizont-client
+
+## Usage
+
+Get the URL you want to send the event to (example: https://ereignishorizont.herokuapp.com/incoming_events)
+
+Create a remote side and get its API token via the Ereignishorizont application.
+
+Create an instance and start sending events:
+
+    client = Ereignishorizont::Client.new('http://example.com', 'mytoken')
+    client.send! 'hello from ereignishorizont-client'
+
+You can optionally send additional payload data:
+
+    client = Ereignishorizont::Client.new('http://example.com', 'mytoken')
+    client.send! 'hello from ereignishorizont-client', 'Optional additional data that will not be matched'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/ereignishorizont

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# vim: ft=ruby
+
+begin
+  require 'ereignishorizont/client'
+rescue LoadError
+  require 'rubygems'
+  require 'ereignishorizont/client'
+end
+
+require 'optparse'
+
+Version = Ereignishorizont::Client::VERSION.dup
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: event_girl [options] EVENTNAME OPTIONAL_DATA"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on('-t', '--token TOKEN', 'Authentication token') do |token|
+    options[:api_token] = token
+  end
+  opts.on('-s', '--site URL', 'URL of API endpoint') do |url|
+    options[:url] = url
+  end
+  opts.on('--debug', 'Display full stack traces') do
+    options[:debug] = true
+  end
+  opts.on_tail('--version', 'Display version and exit') do
+    puts opts.ver
+    puts
+    puts "A Ruby client library to connect to the ereignishorizont app,"
+    puts "written by Susanne Dewein, Tam Eastley, Carsten Zimmermann"
+    puts "as part of the ABSOLVENTA Rails Girls Summer of Code 2013."
+    puts
+    puts "© 2013-2016 Absolventa GmbH"
+    puts "This is free software; see the source for copying conditions."
+    puts "There is NO warranty; not even for MERCHANTABILITY or FITNESS"
+    puts "FOR A PARTICULAR PURPOSE. Licensed under the MIT license."
+    exit
+  end
+  opts.on('-h', '--help', 'Display this help screen') do
+    puts opts
+    exit
+  end
+end
+
+option_parser.parse!
+
+if ARGV.empty?
+  puts "E: Need to specify an event name to send"
+  exit 1
+end
+
+begin
+  client = Ereignishorizont::Client.new(options[:url], options[:api_token])
+  client.send!(ARGV[0], ARGV[1])
+rescue => e
+  puts "E: #{e.message}"
+  puts e.backtrace if options[:debug]
+  exit 1
+end
+exit 0

data/ereignishorizont-client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ereignishorizont/client'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ereignishorizont-client"
+  spec.version       = Ereignishorizont::Client::VERSION
+  spec.authors       = ["Susanne Dewein", "Tam Eastley", "Carsten Zimmermann"]
+  spec.email         = ["susanne.dewein@gmail.com", "tam.eastley@gmail.com", "cz@aegisnet.de"]
+  spec.description   = %q{Ruby client library to connect to ereignishorizont app}
+  spec.summary       = %q{Ruby client library to connect to ereignishorizont app}
+  spec.homepage      = "https://github.com/Absolventa/ereignishorizont-client"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+end

data/lib/ereignishorizont/client.rb

@@ -0,0 +1,77 @@
+require 'net/http'
+require 'uri'
+require 'openssl'
+
+require 'rubygems'
+
+module Ereignishorizont
+  class Client
+
+    VERSION = '2.0.0'
+
+    # Class-wide configuration
+    @@api_token = nil
+    @@url       = nil
+
+    attr_reader :api_token, :url
+
+    def initialize(url = nil, api_token = nil)
+      @url       = (url       || self.class.url)
+      @api_token = (api_token || self.class.api_token).to_s
+      raise ArgumentError.new('No url provided.') unless @url
+    end
+
+    # @deprecated Use {#send!} instead.
+    def send_event(*args)
+      send!(*args)
+    end
+
+    # POSTs a string to the event_girl server.
+    def send!(title, content = nil)
+      uri = URI.parse(url)
+
+      # Auto-correct missing trailing slash
+      path = uri.path == '' ? '/' : uri.path
+
+      # This is all the post request stuff.
+      req = Net::HTTP::Post.new(path)
+
+      # The request format and content type is json
+      req['Accept']       = "application/json"
+      req['Content-Type'] = "application/json"
+
+      # This takes the entered api token and title. This is what is sent. It is a HASH!
+      req.body = '{"api_token":"' + api_token + '","incoming_event":{"title":"' + title.to_s + '","content":"' + content.to_s + '"}}'
+
+      # The request is sent via HTTP to the host and port. You also get a response
+      # ex: 201 (it worked)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      http.use_ssl = ssl?
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      http.request(req)
+    end
+
+    def self.configure
+      yield self if block_given?
+    end
+
+    # class attribute accessors:
+    class_variables.map{|cvar| cvar.to_s.gsub('@@', '') }.each do |cattr|
+      define_singleton_method cattr do
+        class_variable_get :"@@#{cattr}"
+      end
+      define_singleton_method "#{cattr}=" do |value|
+        class_variable_set "@@#{cattr}", value
+      end
+    end
+
+    private
+
+    def ssl?
+      !!/^https:/.match(url)
+    end
+
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe Ereignishorizont::Client do
+
+  subject { described_class.new('http://example.com/incoming_events', 'foobar') }
+
+  context 'with class-level configuration' do
+    %w(api_token url).each do |accessor|
+      it { expect(described_class).to respond_to accessor }
+      it { expect(described_class).to respond_to "#{accessor}=" }
+    end
+
+    describe '.configure' do
+      it 'sets configuration via a block' do
+        described_class.configure do |config|
+          config.api_token = 'abcdef'
+          config.url       = 'https://eg.example.com'
+        end
+        expect(described_class.api_token).to eql 'abcdef'
+        expect(described_class.url).to eql 'https://eg.example.com'
+      end
+    end
+  end
+
+  it 'creates instances with two arguments' do
+    expect(described_class.instance_method(:initialize).arity).to eql(-1)
+  end
+
+  it 'raises an error when url is omitted' do
+    expect do
+      described_class.new(nil, 'abc')
+    end.to raise_error ArgumentError
+  end
+
+  it 'sets the api_token' do
+    subject = described_class.new('', 'abcxyz')
+    expect(subject.api_token).to eql 'abcxyz'
+  end
+
+  it 'sets the url' do
+    subject = described_class.new('http://localhost:3000', nil)
+    expect(subject.url).to eql 'http://localhost:3000'
+  end
+
+  describe '#send_event' do
+    it 'still responds to send_event' do
+      expect(subject).to respond_to :send_event
+    end
+
+    it 'delegates to #send!' do
+      subject.should_receive(:send!).with('foo', 'bar')
+      subject.send_event('foo', 'bar')
+    end
+  end
+
+  describe '#send!' do
+    it 'requires the event title and supports content optionally' do
+      expect(subject.method(:send!).arity).to eql(-2)
+    end
+
+    it 'adds a missing trailing slash' do
+      url = 'http://eg.example.com'
+      stub_request(:post, "#{url}/")
+      subject = described_class.new url
+      expect do
+        subject.send! ''
+      end.not_to raise_error
+    end
+
+    it 'sends json data' do
+      title = 'event girl test'
+      json  = '{"api_token":"' + subject.api_token + '","incoming_event":{"title":"' + title + '","content":""}}'
+      stub_request(:post, subject.url).
+        with(body: json)
+      subject.send! title
+    end
+
+    it 'allows sending of optional content' do
+      title   = 'event girl test'
+      content = 'this is additional payload data'
+      json    = '{"api_token":"' + subject.api_token + '","incoming_event":{"title":"' + title + '","content":"' + content + '"}}'
+      stub_request(:post, subject.url).
+        with(body: json)
+      subject.send! title, content
+    end
+
+    it 'sends json headers' do
+      stub_request(:post, subject.url).
+        with(
+          headers: {
+            'Accept'       => 'application/json',
+            'Content-Type' => 'application/json'
+          }
+        )
+      subject.send! 'event girl test'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'ereignishorizont/client'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: ereignishorizont-client
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Susanne Dewein
+- Tam Eastley
+- Carsten Zimmermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: webmock
+  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: Ruby client library to connect to ereignishorizont app
+email:
+- susanne.dewein@gmail.com
+- tam.eastley@gmail.com
+- cz@aegisnet.de
+executables:
+- ereignishorizont
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ereignishorizont
+- ereignishorizont-client.gemspec
+- lib/ereignishorizont/client.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Absolventa/ereignishorizont-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client library to connect to ereignishorizont app
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb