event_girl_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2397f94943016aa59c3c0fca30206895f661e49
+  data.tar.gz: 0b5c3e16b4ef47c32ab7cd1bcd801bae5e36d114
+SHA512:
+  metadata.gz: 98c230c7d5b13868f75c3b312f0931668c758730106004cd4ebe910818db11bcc52653df5607fbb36d88901b61a901bad0e1aa96a2a7431cf19ef7fcc5d00f81
+  data.tar.gz: aefc97b7038b3cc8bd43f7a9b5df2a7cfc02d2ac58586215aececfe4602c817fa16639bf7f485b2504ca0a5577bb3ddb189cab38778a9de3daccdf4a2be87f7f

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.0.0-p247

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,50 @@
+# EventGirlClient
+
+EventGirlClient can be used in your own app to send
+events to an external Event Girl Application such as 
+[event-girl.herokuapp.com](event-girl.herokuapp.com).
+It is the gem for [Event Girl](https://github.com/Absolventa/event_girl)
+which was part of a project
+for the [Rails Girls Summer of Code](http://railsgirlssummerofcode.org).
+Its two main contributors are the 
+Rails Girls Susanne and Tam who worked on the project 
+from July 2 - September 30, 2013 at the [ABSOLVENTA](http://www.absolventa.de)
+offices in Berlin.
+
+Using an initializer file for Rails, you can do:
+
+    EventGirl::Client.configure do |config|
+      config.api_token = 'my-api-token'
+      config.url = 'http://my-eventgirl-endpoint.example.com'
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'event_girl_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event_girl_client
+
+## Usage
+
+- Get the URL you want to send the event to 
+    - example: www.event-girl.herokuapp.com/incoming_events
+- Create an API token via the Event Girl application
+- Insert the `send_event(title)` method into your code
+    - title must be the title of the event you want to track
+- Start sending events!
+
+## 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/event_girl

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# vim: ft=ruby
+# encoding: utf-8
+
+begin
+  require 'event_girl_client'
+rescue LoadError
+  require 'rubygems'
+  require 'event_girl_client'
+end
+
+require 'optparse'
+
+Version = EventGirl::Client::VERSION.dup
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: event_girl [options] EVENTNAME"
+
+  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_tail('--version', 'Display version and exit') do
+    puts opts.ver
+    puts
+    puts "A Ruby client library to connect to the event_girl 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 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
+
+client = EventGirl::Client.new(options[:url], options[:api_token])
+client.send_event(ARGV[0])
+exit 0

data/event_girl_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 'event_girl_client'
+
+Gem::Specification.new do |spec|
+  spec.name          = "event_girl_client"
+  spec.version       = EventGirl::Client::VERSION
+  spec.authors       = ["Susanne Dewein", "Tam Eastley"]
+  spec.email         = ["susanne.dewein@gmail.com", "tam.eastley@gmail.com"]
+  spec.description   = %q{Ruby client library to connect to event_girl app}
+  spec.summary       = %q{Ruby client library to connect to event_girl app}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_dependency "activesupport", ">= 3.0", "< 4.1"
+
+  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/event_girl_client.rb

@@ -0,0 +1,43 @@
+require 'net/http'
+require 'uri'
+require 'active_support/core_ext/class'
+
+require 'rubygems'
+
+module EventGirl
+  class Client
+
+    VERSION = '1.0.0'
+
+    cattr_accessor :api_token, :url
+    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
+
+    def send_event(title)
+      uri = URI.parse(url)
+
+      # This is all the post request stuff.
+      req = Net::HTTP::Post.new(uri.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 + '"}}'
+
+      # The request is sent via HTTP to the host and port. You also get a response
+      # ex: 201 (it worked)
+      Net::HTTP.new(uri.host, uri.port).start { |http| http.request(req) }
+    end
+
+    def self.configure
+      yield self if block_given?
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe EventGirl::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 'requires the event title as argument' do
+      expect(subject.method(:send_event).arity).to eql 1
+    end
+
+    it 'sends json data' do
+      title = 'event girl test'
+      json  = '{"api_token":"' + subject.api_token + '","incoming_event":{"title":"' + title + '"}}'
+      stub_request(:post, subject.url).
+        with(body: json)
+      subject.send_event title
+    end
+
+    it 'sends json headers' do
+      stub_request(:post, subject.url).
+        with(
+          headers: {
+            'Accept'       => 'application/json',
+            'Content-Type' => 'application/json'
+          }
+        )
+      subject.send_event 'event girl test'
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: event_girl_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Susanne Dewein
+- Tam Eastley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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 event_girl app
+email:
+- susanne.dewein@gmail.com
+- tam.eastley@gmail.com
+executables:
+- event_girl
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/event_girl
+- event_girl_client.gemspec
+- lib/event_girl_client.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client library to connect to event_girl app
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb