slack-rtm-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b712bcb1116dcb56dfc87445c8d7e2b538d59c68
+  data.tar.gz: aa218a36ea07d1520442c6cf0d6de33dfc254783
+SHA512:
+  metadata.gz: 345cfa08610b64a8c639e2723d7998d89102a62428b69836a7e08f09b3dcdfcc7c7819d0595de4db47cfce3f7c02788085a6349e992704d3917d751c76fb974a
+  data.tar.gz: b4e7915b35e1be890e0987a7bd2129e8c5498b41fe400b88a43d4f76f8aaa17ce963f7f0c17fd799d2a99e49f54d5c162ba70cbe0a7a258f23991682b2579bb6

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+.rvmrc
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in getyourguide.gemspec
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'pry-byebug'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rémi Delhaye
+
+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 @@
+README coming soon

data/Rakefile

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

data/lib/slack-rtm-api.rb

@@ -0,0 +1,6 @@
+require "slack-rtm-api/version"
+require "slack-rtm-api/api_client"
+require "slack-rtm-api/client_wrapper"
+
+module SlackRTMApi
+end

data/lib/slack-rtm-api/api_client.rb

@@ -0,0 +1,121 @@
+require 'json'
+require 'socket'
+require 'websocket/driver'
+require 'logger'
+
+module SlackRTMApi
+
+  class ApiClient
+    VALID_DRIVER_EVENTS = [:open, :message, :error]
+    BASE_URL            = 'https://slack.com/api'
+    RTM_START_PATH      = '/rtm.start'
+
+    def initialize(token, silent = true)
+      @logger     = logger = Logger.new(STDOUT) unless silent
+      @token      = token
+      @silent     = silent
+      @ready      = false
+      @connected  = false
+
+      if token.nil?
+        raise ArgumentError.new "You should pass a valid RTM Websocket url"
+      else
+        @url = get_ws_url
+      end
+
+      @event_handlers = {}
+      @events_queue   = []
+    end
+
+    def bind(type, &block)
+      unless VALID_DRIVER_EVENTS.include? type
+        raise ArgumentError.new "The event `#{type}` doesn't exist, available events are: #{VALID_DRIVER_EVENTS}"
+      end
+
+      @event_handlers[type] = block
+    end
+
+    def send(event)
+      event[:id] = random_id
+      @events_queue << event.to_json
+    end
+
+    def init
+      return if @ready
+
+      @socket = OpenSSL::SSL::SSLSocket.new TCPSocket.new(@url.host, 443)
+      @socket.connect
+
+      @driver = WebSocket::Driver.client SlackRTMApi::ClientWrapper.new(@url.to_s, @socket)
+
+      @driver.on :open do
+        @connected = true
+        send_log "WebSocket::Driver is now connected"
+        @event_handlers[:open].call unless @event_handlers[:open].nil?
+      end
+
+      @driver.on :error do |event|
+        @connected = false
+        send_log "WebSocket::Driver recieved an error"
+        @event_handlers[:error].call unless @event_handlers[:error].nil?
+      end
+
+      @driver.on :message do |event|
+        data = JSON.parse event.data
+        send_log "WebSocket::Driver recieved an event with data: #{data}"
+        @event_handlers[:message].call data unless @event_handlers[:message].nil?
+      end
+
+      @driver.start
+
+      @ready = true
+    end
+
+    def check_ws
+      data = @socket.readpartial 4096
+
+      return if data.nil? or data.empty?
+
+      @driver.parse data
+
+      handle_events_queue
+    end
+
+    def handle_events_queue
+      @events_queue.each do |event|
+        send_log "WebSocket::Driver send #{event}"
+        @driver.text event
+      end
+
+      @events_queue.clear
+    end
+
+    def start
+      t = Thread.new do
+        init
+        loop do
+          check_ws
+        end
+      end
+
+      t.abort_on_exception = true
+    end
+
+    private
+
+    def get_ws_url
+      req   = Net::HTTP.post_form URI(BASE_URL + RTM_START_PATH), token: @token
+      body  = JSON.parse req.body
+      URI body['url']
+    end
+
+    def send_log(log)
+      @logger.info(log) unless @silent
+    end
+
+    def random_id
+      SecureRandom.random_number 9999999
+    end
+  end
+
+end

data/lib/slack-rtm-api/client_wrapper.rb

@@ -0,0 +1,14 @@
+module SlackRTMApi
+  class ClientWrapper
+    attr_accessor :url, :socket
+
+    def initialize(url, socket)
+      @url    = url
+      @socket = socket
+    end
+
+    def write(*args)
+      self.socket.write(*args)
+    end
+  end
+end

data/lib/slack-rtm-api/version.rb

@@ -0,0 +1,3 @@
+module SlackRTMApi
+  VERSION = "0.0.1"
+end

data/slack-rtm-api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+require File.expand_path('../lib/slack-rtm-api/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name                   = 'slack-rtm-api'
+  spec.version                = SlackRTMApi::VERSION
+  spec.authors                = ['Rémi Delhaye']
+  spec.email                  = ['contact@rdlh.io']
+  spec.summary                = 'A simple Slack RTM API Client'
+  spec.description            = 'A simple Slack RTM API Client'
+  spec.homepage               = 'https://github.com/rdlh/slack-rtm-api'
+  spec.license                = 'MIT'
+  spec.required_ruby_version  = '~> 2.0'
+
+  spec.files                  = `git ls-files -z`.split("\x0")
+  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']
+
+  dev_dep = %w(
+    bundler
+    rake
+    colored
+  )
+
+  run_dep = %w(
+    websocket-driver
+  )
+
+  dev_dep.each { |d| spec.add_development_dependency d }
+  run_dep.each { |d| spec.add_runtime_dependency d }
+end

data/spec/getyourguide/models/activity_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe GetYourGuide::Models::Activity do
+  subject(:category) {
+    GetYourGuide::Models::Category.new(
+      provider_id: 1,
+      name: 'Name'
+    )
+  }
+  subject(:location) {
+    GetYourGuide::Models::Location.new(
+      provider_id: 1,
+      name: 'Name',
+      country: 'Country',
+      start_location: false
+    )
+  }
+  subject(:image) {
+    GetYourGuide::Models::Image.new(
+      url: 'https://assets-cdn.github.com/images/modules/open_graph/github-mark.png',
+      ssl: true
+    )
+  }
+  subject(:activity) {
+    GetYourGuide::Models::Activity.new(
+      provider_id: 1,
+      title: 'Title',
+      abstract: 'Abstract description',
+      categories: [category],
+      locations: [location],
+      starting_point: true,
+      indivative_price: 100.50,
+      rating: 4.5,
+      pictures: [image]
+    )
+  }
+
+  it 'should be a GetYourGuide::Models::Activity object' do
+    expect(activity).to be_an_instance_of(GetYourGuide::Models::Activity)
+  end
+
+  it 'should have a provider_id' do
+    expect(activity.provider_id).to eq(1)
+    expect(activity.provider_id).to be_an_instance_of(Fixnum)
+  end
+
+  it 'should have a title' do
+    expect(activity.title).to eq('Title')
+    expect(activity.title).to be_an_instance_of(String)
+  end
+
+  it 'should have a abstract description' do
+    expect(activity.abstract).to eq('Abstract description')
+    expect(activity.abstract).to be_an_instance_of(String)
+  end
+
+  it 'should have a Boolean starting_point' do
+    expect(activity.starting_point).to eq(true).or eq(false)
+  end
+
+  it 'should have a Float indivative_price' do
+    expect(activity.indivative_price).to be_an_instance_of(Float)
+  end
+
+  it 'should have a Float rating' do
+    expect(activity.rating).to be_an_instance_of(Float)
+  end
+
+  it 'should have an Array[GetYourGuide::Models::Category] as categories' do
+    expect(activity.categories).to be_an_instance_of(Array)
+    expect(activity.categories.first).to be_an_instance_of(GetYourGuide::Models::Category)
+  end
+
+  it 'should have an Array[GetYourGuide::Models::Location] as locations' do
+    expect(activity.locations).to be_an_instance_of(Array)
+    expect(activity.locations.first).to be_an_instance_of(GetYourGuide::Models::Location)
+  end
+
+  it 'should have an Array[GetYourGuide::Models::Image] as pictures' do
+    expect(activity.pictures).to be_an_instance_of(Array)
+    expect(activity.pictures.first).to be_an_instance_of(GetYourGuide::Models::Image)
+  end
+end

data/spec/getyourguide/models/category_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe GetYourGuide::Models::Category do
+  subject(:category) {
+    GetYourGuide::Models::Category.new(
+      provider_id: 1,
+      name: 'Name'
+    )
+  }
+
+  it 'should be a GetYourGuide::Models::Category object' do
+    expect(category).to be_an_instance_of(GetYourGuide::Models::Category)
+  end
+
+  it 'should have a provider_id' do
+    expect(category.provider_id).to eq(1)
+    expect(category.provider_id).to be_an_instance_of(Fixnum)
+  end
+
+  it 'should have a name' do
+    expect(category.name).to eq('Name')
+    expect(category.name).to be_an_instance_of(String)
+  end
+end

data/spec/getyourguide/models/destination_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe GetYourGuide::Models::Destination do
+  subject(:destination) {
+    GetYourGuide::Models::Destination.new(
+      provider_id: 1,
+      name: 'Name',
+      country: 'Country',
+      unlocode: 'FR',
+      iata: 'EUR',
+      destination_type: 'Destination Type'
+    )
+  }
+  subject(:destination_with_nil_attributes) {
+    GetYourGuide::Models::Destination.new(
+      provider_id: 1,
+      name: 'Name',
+      country: 'Country',
+      unlocode: nil,
+      iata: nil,
+      destination_type: 'Destination Type'
+    )
+  }
+
+  it 'should be a GetYourGuide::Models::Destination object' do
+    expect(destination).to be_an_instance_of(GetYourGuide::Models::Destination)
+  end
+
+  it 'should have a provider_id' do
+    expect(destination.provider_id).to eq(1)
+    expect(destination.provider_id).to be_an_instance_of(Fixnum)
+  end
+
+  it 'should have a name' do
+    expect(destination.name).to eq('Name')
+    expect(destination.name).to be_an_instance_of(String)
+  end
+
+  it 'should have a country' do
+    expect(destination.country).to eq('Country')
+    expect(destination.country).to be_an_instance_of(String)
+  end
+
+  context 'WITH iata and un/locode' do
+    it 'should have a not null iata' do
+      expect(destination.iata).to eq('EUR')
+      expect(destination.iata).to be_an_instance_of(String)
+    end
+
+    it 'should have a not null un/locode' do
+      expect(destination.unlocode).to eq('FR')
+      expect(destination.unlocode).to be_an_instance_of(String)
+    end
+  end
+
+  context 'WITHOUT iata and un/locode' do
+    it 'should have a null iata' do
+      expect(destination_with_nil_attributes.iata).to be_nil
+    end
+
+    it 'should have a null un/locode' do
+      expect(destination_with_nil_attributes.unlocode).to be_nil
+    end
+  end
+
+  it 'should have a destination_type' do
+    expect(destination.destination_type).to eq('Destination Type')
+    expect(destination.destination_type).to be_an_instance_of(String)
+  end
+end

data/spec/getyourguide/models/image_format_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe GetYourGuide::Models::ImageFormat do
+  subject(:image_format) {
+    GetYourGuide::Models::ImageFormat.new(
+      provider_id: 1,
+      width: 200,
+      height: 300,
+      comment: 'Comment'
+    )
+  }
+
+  it 'should be a GetYourGuide::Models::ImageFormat object' do
+    expect(image_format).to be_an_instance_of(GetYourGuide::Models::ImageFormat)
+  end
+
+  it 'should have a provider_id' do
+    expect(image_format.provider_id).to eq(1)
+    expect(image_format.provider_id).to be_an_instance_of(Fixnum)
+  end
+
+  it 'should have a width' do
+    expect(image_format.width).to eq(200)
+    expect(image_format.width).to be_an_instance_of(Fixnum)
+  end
+
+  it 'should have a height' do
+    expect(image_format.height).to eq(300)
+    expect(image_format.height).to be_an_instance_of(Fixnum)
+  end
+
+  it 'should have a comment' do
+    expect(image_format.comment).to eq('Comment')
+    expect(image_format.comment).to be_an_instance_of(String)
+  end
+end

data/spec/getyourguide/models/image_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe GetYourGuide::Models::Image do
+  subject(:image) {
+    GetYourGuide::Models::Image.new(
+      url: 'https://assets-cdn.github.com/images/modules/open_graph/github-mark.png',
+      ssl: true
+    )
+  }
+
+  it 'should be a GetYourGuide::Models::Image object' do
+    expect(image).to be_an_instance_of(GetYourGuide::Models::Image)
+  end
+
+  it 'should have a String url' do
+    expect(image.url).to eq('https://assets-cdn.github.com/images/modules/open_graph/github-mark.png')
+    expect(image.url).to be_an_instance_of(String)
+  end
+
+  it 'should have a Boolean ssl' do
+    expect(image.ssl).to eq(true).or eq(false)
+  end
+end

data/spec/getyourguide/models/location_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe GetYourGuide::Models::Location do
+  subject(:location) {
+    GetYourGuide::Models::Location.new(
+      provider_id: 1,
+      name: 'Name',
+      country: 'Country',
+      start_location: true
+    )
+  }
+
+  it 'should be a GetYourGuide::Models::Location object' do
+    expect(location).to be_an_instance_of(GetYourGuide::Models::Location)
+  end
+
+  it 'should have a provider_id' do
+    expect(location.provider_id).to eq(1)
+    expect(location.provider_id).to be_an_instance_of(Fixnum)
+  end
+
+  it 'should have a name' do
+    expect(location.name).to eq('Name')
+    expect(location.name).to be_an_instance_of(String)
+  end
+
+  it 'should have a country' do
+    expect(location.country).to eq('Country')
+    expect(location.country).to be_an_instance_of(String)
+  end
+
+  it 'should have a start_location' do
+    expect(location.start_location).to eq(true).or eq(false)
+  end
+end

data/spec/getyourguide/models/top_category_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe GetYourGuide::Models::TopCategory do
+  subject(:top_category) {
+    GetYourGuide::Models::TopCategory.new(
+      provider_id: 1,
+      name: 'Name',
+      link: 'Link',
+      picture: 'Picture',
+      rating: 'Rating'
+    )
+  }
+
+  it 'should be a GetYourGuide::Models::TopCategory object' do
+    expect(top_category).to be_an_instance_of(GetYourGuide::Models::TopCategory)
+  end
+
+  it 'should have a provider_id' do
+    expect(top_category.provider_id).to eq(1)
+    expect(top_category.provider_id).to be_an_instance_of(Fixnum)
+  end
+
+  it 'should have a name' do
+    expect(top_category.name).to eq('Name')
+    expect(top_category.name).to be_an_instance_of(String)
+  end
+
+  it 'should have a link' do
+    expect(top_category.link).to eq('Link')
+    expect(top_category.link).to be_an_instance_of(String)
+  end
+
+  it 'should have a picture' do
+    expect(top_category.picture).to eq('Picture')
+    expect(top_category.picture).to be_an_instance_of(String)
+  end
+
+  it 'should have a rating' do
+    expect(top_category.rating).to eq('Rating')
+    expect(top_category.rating).to be_an_instance_of(String)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'getyourguide'
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: slack-rtm-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rémi Delhaye
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: colored
+  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: websocket-driver
+  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: A simple Slack RTM API Client
+email:
+- contact@rdlh.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slack-rtm-api.rb
+- lib/slack-rtm-api/api_client.rb
+- lib/slack-rtm-api/client_wrapper.rb
+- lib/slack-rtm-api/version.rb
+- slack-rtm-api.gemspec
+- spec/getyourguide/models/activity_spec.rb
+- spec/getyourguide/models/category_spec.rb
+- spec/getyourguide/models/destination_spec.rb
+- spec/getyourguide/models/image_format_spec.rb
+- spec/getyourguide/models/image_spec.rb
+- spec/getyourguide/models/location_spec.rb
+- spec/getyourguide/models/top_category_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rdlh/slack-rtm-api
+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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A simple Slack RTM API Client
+test_files:
+- spec/getyourguide/models/activity_spec.rb
+- spec/getyourguide/models/category_spec.rb
+- spec/getyourguide/models/destination_spec.rb
+- spec/getyourguide/models/image_format_spec.rb
+- spec/getyourguide/models/image_spec.rb
+- spec/getyourguide/models/location_spec.rb
+- spec/getyourguide/models/top_category_spec.rb
+- spec/spec_helper.rb