peertransfer_chat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e61b658dd3fd215ac1a6c45ef402e47a903dea438b206c50c92d4de629cc175f
+  data.tar.gz: 343fb35a960fbddf8390efa25c19f6d61a2487a1b7a066a3e550fecef9336062
+SHA512:
+  metadata.gz: ef0dac732634c6448868e5588f0044c27367ceb3452fdb5a1f99aaccbb5fdac20f2416dbdf875ba34e3b940e681e3b75c01847da552a2bd2b6cf89f85155666b
+  data.tar.gz: 3d08e5b7df60265c04effee0dd2e416001c73a7cb97b3b59b33d7a06cfab10e2c13f93e6add5ec19b65ea72aa6e3ca8a1ad9a5ccad608e8a5b839b6e68427d3c

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/bundle

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in peertransfer_chat.gemspec
+gemspec
+
+gem 'rspec', '~> 3.5'

data/README.md

@@ -0,0 +1,56 @@
+# PeertransferChat
+
+A wrapper that works as a unique interface to integrate a chat system into the peerTransfer platform.
+
+## Build Status
+
+[![Build Status](https://secure.travis-ci.org/peertransfer/peertransfer_chat.png)](http://travis-ci.org/peertransfer/peertransfer_chat)
+[![Coverage Status](https://coveralls.io/repos/peertransfer/peertransfer_chat/badge.svg?branch=master)](https://coveralls.io/r/peertransfer/peertransfer_chat)
+[![Code Climate](https://codeclimate.com/github/peertransfer/peertransfer_chat.png)](https://codeclimate.com/github/peertransfer/peertransfer_chat)
+[![Dependency Status](https://gemnasium.com/peertransfer/peertransfer_chat.png)](https://gemnasium.com/peertransfer/peertransfer_chat)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'peertransfer_chat', git: 'https://github.com/peertransfer/peertransfer_chat.git'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install peertransfer_chat
+
+## Usage
+
+Configure the chat client:
+
+```ruby
+PeertransferChat.configure do |config|
+  config.team = team_name
+  config.incoming_token = team_token
+  config.channel = team_channel
+  config.username = team_username
+end
+```
+
+Send a message:
+
+```ruby
+PeertransferChat::Client.speak('There are issues pending review')
+```
+
+Upload a file:
+```ruby
+PeertransferChat::Client.upload('/path/to/a/file.txt')
+```
+
+## Slack settings description
+ - `team` Your team
+ - `channel` Channel name
+ - `api_token` This token comes from your user https://api.slack.com/web
+ - `rtm_token` Real time messaging, you can find it in integration -> bot -> token
+ - `incomming_token` Incoming web hook token, you can create one in  integration -> incomming webhooks
+ - `channel_id` Channel id you can find it in the code of your slack team web page

data/lib/peertransfer_chat/client.rb

@@ -0,0 +1,53 @@
+require 'slackr'
+
+module PeertransferChat
+  class Client
+
+    def self.upload(filename)
+      new.upload(filename)
+    end
+
+    def self.speak(something)
+      new.speak(something)
+    end
+
+    def upload(filename)
+      slack = Slackr.connect(team, api_token, slack_opts)
+      slack.upload(filename, { 'channels' => channel_id })
+    end
+
+    def speak(message)
+      slack = Slackr.connect(team, incoming_token, slack_opts)
+      slack.say(message)
+    end
+
+    private
+
+    def team
+      config.team
+    end
+
+    def incoming_token
+      config.incoming_token
+    end
+
+    def api_token
+      config.api_token
+    end
+
+    def channel_id
+      config.channel_id
+    end
+
+    def slack_opts
+      {
+        'channel' => config.channel,
+        'username' => config.username
+      }
+    end
+
+    def config
+      PeertransferChat.config
+    end
+  end
+end

data/lib/peertransfer_chat/config.rb

@@ -0,0 +1,27 @@
+module PeertransferChat
+  class Config
+    SETTINGS = [:team, :channel, :incoming_token, :username, :api_token, :channel_id]
+
+    attr_accessor *SETTINGS
+
+    def valid?
+      @team && @channel && @incoming_token && @username
+    end
+  end
+
+  class << self
+    def configure
+      @config ||= Config.new
+      yield(@config)
+    end
+
+    def reset!
+      @config = Config.new
+    end
+
+    def config
+      raise('configuration is wrong') unless @config.valid?
+      @config
+    end
+  end
+end

data/lib/peertransfer_chat/version.rb

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

data/lib/peertransfer_chat.rb

@@ -0,0 +1,3 @@
+require 'peertransfer_chat/version'
+require 'peertransfer_chat/config'
+require 'peertransfer_chat/client'

data/peertransfer_chat.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'peertransfer_chat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'peertransfer_chat'
+  spec.version       = PeertransferChat::VERSION
+  spec.authors       = ['peerTransfer tech']
+  spec.email         = ['tech@peertransfer.com']
+  spec.summary       = %q{A common interface to our chat system}
+  spec.description   = %q{A common interface to our chat system}
+
+  files = Dir['lib/*.rb'] + Dir['lib/**/*.rb']
+  rootfiles = ['Gemfile', 'peertransfer_chat.gemspec', 'README.md']
+  dotfiles = ['.gitignore']
+
+  spec.files = files + rootfiles + dotfiles
+  spec.test_files = Dir['spec/*.rb'] + Dir['spec/**/*.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'slackr', '0.0.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+end

data/spec/integration/client_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe PeertransferChat::Client do
+  let(:slack_client) { instance_double(Slackr) }
+  let(:team_name) { 'a team' }
+  let(:team_token) { 'a token' }
+  let(:team_channel) { 'a channel' }
+  let(:team_username) { 'a username' }
+  let(:opts) { { 'channel' => team_channel, 'username' => team_username } }
+
+  after do
+   PeertransferChat.reset!
+  end
+
+  before do
+    PeertransferChat.configure do |c|
+      c.team = team_name
+      c.incoming_token = team_token
+      c.channel = team_channel
+      c.username = team_username
+    end
+
+    allow(Slackr).to receive(:connect).
+      with(team_name, team_token, opts).
+      and_return(slack_client)
+  end
+
+  describe '.say' do
+    it 'speaks something to a channel' do
+      expect(slack_client).to receive(:say).with('hello')
+
+      described_class.speak('hello')
+    end
+  end
+end

data/spec/lib/client_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe PeertransferChat::Client do
+  let(:slack_client) { instance_double(Slackr) }
+  let(:team_name) { 'a team' }
+  let(:team_token) { 'a token' }
+  let(:api_token) { 'an api token' }
+  let(:team_channel) { 'a channel' }
+  let(:team_username) { 'a username' }
+  let(:opts) { { 'channel' => team_channel, 'username' => team_username } }
+
+  before do
+    allow(PeertransferChat).to receive(:config).and_return(
+      double(
+        PeertransferChat::Config,
+        team: team_name,
+        incoming_token: team_token,
+        channel: team_channel,
+        username: team_username,
+        channel_id: 'C026VKGP7',
+        api_token: api_token
+      )
+    )
+  end
+
+  describe '.upload' do
+    it 'uploads image to a channel' do
+      allow(Slackr).to receive(:connect).
+        with(team_name, api_token, opts).
+        and_return(slack_client)
+
+      expect(slack_client).to receive(:upload).with('/foo/bar.bin', { 'channels' => 'C026VKGP7' })
+
+      described_class.upload('/foo/bar.bin')
+    end
+  end
+
+  describe '.say' do
+    it 'speaks something to a channel' do
+      allow(Slackr).to receive(:connect).
+        with(team_name, team_token, opts).
+        and_return(slack_client)
+
+      expect(slack_client).to receive(:say).with('hello')
+
+      described_class.speak('hello')
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe PeertransferChat::Config do
+  let(:team_name) { 'a team' }
+  let(:team_token) { 'a token' }
+  let(:team_channel) { 'a channel' }
+  let(:team_username) { 'a username' }
+
+  context 'when configured' do
+    before do
+      PeertransferChat.configure do |config|
+        config.team = team_name
+        config.incoming_token = team_token
+        config.channel = team_channel
+        config.username = team_username
+      end
+    end
+
+    describe '.reset' do
+      it 'reset any previous config' do
+        PeertransferChat.reset!
+
+        expect do
+          PeertransferChat.config.username
+        end.to raise_error('configuration is wrong')
+      end
+    end
+
+    it 'stores config' do
+      expect(PeertransferChat.config.team).to eq('a team')
+    end
+  end
+
+  context 'not configured' do
+    before do
+      PeertransferChat.configure do |config|
+        config.team = team_name
+        config.incoming_token = team_token
+        config.channel = team_channel
+      end
+    end
+
+    it 'raises an exception if all values are not set' do
+      expect do
+        PeertransferChat.config.username
+      end.to raise_error('configuration is wrong')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/vendor/'
+end
+
+require 'peertransfer_chat'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: peertransfer_chat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- peerTransfer tech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slackr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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: A common interface to our chat system
+email:
+- tech@peertransfer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/peertransfer_chat.rb
+- lib/peertransfer_chat/client.rb
+- lib/peertransfer_chat/config.rb
+- lib/peertransfer_chat/version.rb
+- peertransfer_chat.gemspec
+- spec/integration/client_spec.rb
+- spec/lib/client_spec.rb
+- spec/lib/config_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+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.7.7
+signing_key: 
+specification_version: 4
+summary: A common interface to our chat system
+test_files:
+- spec/spec_helper.rb
+- spec/integration/client_spec.rb
+- spec/lib/client_spec.rb
+- spec/lib/config_spec.rb