typetalk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8abe69ef420d358276adc435f463c3bcdbb1d17
+  data.tar.gz: cf7b032089f7482505217065765e9b7614e37859
+SHA512:
+  metadata.gz: 286c0578f142feff79ed45b1f1757e4bc15591301feba0dc4cfe116431e1f8f73efdb52bb10538966c858d24a9f024dbeda0a5bb1ac8943a6b1e282021b13cc8
+  data.tar.gz: 6576852ef676d8745a7a9a3010040c3e5ee73f00830999f3692170275fd98caab156b902f396635a29271bc166832615e1feead36b9e11814668eacf484a0104

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/

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format=nested
+--backtrace
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 umakoz
+
+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,215 @@
+# Typetalk
+
+A Ruby wrapper for [Typetalk API](http://developers.typetalk.in/api.html). The Typetalk gem provides an easy-to-use wrapper for Typetalk's REST APIs.
+
+
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'typetalk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typetalk
+
+
+
+
+
+## Configuration
+
+You need to provide your Client ID and Client Secret.
+
+    Typetalk.configure do |config|
+      config.client_id = '...'
+      config.client_secret = '...'
+      # option
+      config.scope = 'topic.read,topic.post,my'
+      config.grant_type = 'client_credentials' # or 'authorization_code'
+      config.redirect_uri = '...' # for authorization code
+      config.proxy = '...'
+    end
+
+You can also specify these values via ENV:
+
+    export TYPETALK_CLIENT_ID='...'
+    export TYPETALK_CLIENT_SECRET='...'
+
+
+
+
+
+## Usage
+
+### Authetication
+
+It is usually not necessary if there is a configuration, because it automatically acquires.
+
+    require 'rubygems'
+    require 'typetalk'
+    
+    api = Typetalk::Api.new
+    
+    # Get access token using client credentials
+    response = api.get_access_token(scope: 'my')
+    access_token = response.access_token
+
+
+
+### Profile
+
+    # api is a Typetalk::Api
+    
+    # Get my profile
+    response = api.get_profile
+    my_name = response.account.name
+    my_full_name = response.account.fullName
+
+
+
+### Topics
+
+    # api is a Typetalk::Api
+    
+    # Get my topics
+    response = api.get_topics
+    topic_id = response.topics[0].topic.id
+    topic_name = response.topics[0].topic.name
+    
+    # Get topic messages
+    topic = api.get_topic(topic_id)
+    post_id = topic.posts[0].id
+    message_text = topic.posts[0].message
+    sender = topic.posts[0].account.name
+    
+    # Get topic members
+    members = api.get_topic_members(topic_id)
+    member_id = members.accounts[0].account.id
+    member_name = members.accounts[0].account.name
+    
+    # Favorite topic
+    api.favorite_topic(topic_id)
+    
+    # unfavorite topic
+    api.unfavorite_topic(topic_id)
+
+
+
+### Message
+
+    # api is a Typetalk::Api
+    
+    # Post message
+    api.post_message(topic_id, 'message text')
+    
+    # Post message with attachment
+    attachment = api.upload_attachment(topic_id, '/path/to/attachment.jpg')
+    response = api.post_message(topic_id, 'message text', file_keys:[attachment.fileKey])
+    
+    # Get message
+    message = api.get_message(topic_id, response.post.id)
+    message_text = message.post.message
+    sender = message.post.account.name
+    
+    # Like message
+    api.like_message(topic_id, post_id)
+    
+    # Unlike message
+    api.unlike_message(topic_id, post_id)
+    
+    # Read message
+    api.read_message(topic_id, post_id)
+    
+    # Read all messages
+    api.read_message(topic_id)
+    
+    # Remove message
+    api.remove_message(topic_id, post_id)
+
+
+
+### Notification
+
+    # api is a Typetalk::Api
+    
+    # Get notification list
+    response = api.get_notifications
+    # Team invitation
+    team_id = response.invites.teams[0].team.id
+    invite_team_id = response.invites.teams[0].id
+    # Topic invitation
+    topic_id = response.invites.topic[0].topic.id
+    invite_topic_id = response.invites.topic[0].id
+    # Mention
+    mention_message_text = response.mentions[0].post.message
+    mention_topic_name = response.mentions[0].post.topic.name
+    mention_sender = response.mentions[0].post.account.name
+    
+    # Get notification count
+    response = api.get_notifications_status
+    unopened = response.access.unopened
+    team_pending = response.invite.team.pending
+    topic_pending = response.invite.topic.pending
+    mention_unread = response.mention.unread
+    
+    # Read notification
+    api.read_notifications
+    
+    # Accept team invitation
+    api.accept_team(team_id, invite_team_id)
+    
+    # Decline team invitation
+    api.decline_team(team_id, invite_team_id)
+    
+    # Accept topic invitation
+    api.accept_topic(topic_id, invite_topic_id)
+    
+    # Decline topic invitation
+    api.decline_topic(topic_id, invite_topic_id)
+
+
+
+### Mention
+
+    # api is a Typetalk::Api
+
+    # Get mention list
+    response = api.get_mentions
+    mention_id = response.mentions[0].id
+    message_text = response.mentions[0].post.message
+    topic_name = response.mentions[0].post.topic.name
+    sender = response.mentions[0].post.account.name
+    
+    # Get unread mention list
+    response = api.get_mentions(unread:true)
+    
+    # Read mention
+    api.read_mention(mention_id)
+
+
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/umakoz/typetalk/fork )
+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 a new Pull Request
+
+
+
+
+
+## Copyright
+
+Copyright (c) 2014- [Makoto Umami](mailto:umakoz@gmail.com). See [LICENSE](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/typetalk.rb

@@ -0,0 +1,36 @@
+require "typetalk/version"
+require 'typetalk/error'
+require 'typetalk/api'
+
+require 'hashie'
+
+
+module Typetalk
+
+  DEFAULT_OPTIONS = {
+    client_id: ENV['TYPETALK_CLIENT_ID'],
+    client_secret: ENV['TYPETALK_CLIENT_SECRET'],
+    redirect_uri: nil,
+    grant_type: 'client_credentials', # or 'authorization_code'
+    scope: 'topic.read,topic.post,my',
+    endpoint: 'https://typetalk.in/api/v1',
+    proxy: nil,
+  }
+
+  class << self
+
+    def config
+      @config ||= Hashie::Mash.new(Typetalk::DEFAULT_OPTIONS)
+    end
+
+    def reset_config
+      @config = nil
+    end
+
+    def configure
+      yield config
+    end
+
+  end
+
+end

data/lib/typetalk/api.rb

@@ -0,0 +1,49 @@
+require 'typetalk/connection'
+
+module Typetalk
+
+  class Api
+    include Connection
+
+    Dir[File.join(__dir__, 'api/*.rb')].each{|f| require f}
+    include Auth
+    include User
+    include Topic
+    include Message
+    include Mention
+    include Notification
+
+
+    def access_token
+      @access_token ||= get_access_token
+      @access_token['access_token']
+    end
+
+
+    protected
+    def parse_response(response)
+
+      # TODO remove debug print
+      #require 'awesome_print'
+      #ap response
+
+      case response.status
+      when 400, 401
+        raise InvalidRequest, response_values(response)
+      when 404
+        raise NotFound, response_values(response)
+      when 413
+        raise InvalidFileSize, response_values(response)
+      end
+
+      body = JSON.parse(response.body) rescue response.body
+      body.is_a?(Hash) ? Hashie::Mash.new(body) : body
+    end
+
+    def response_values(response)
+      {status: response.status, headers: response.headers, body: response.body}
+    end
+
+  end
+
+end

data/lib/typetalk/api/auth.rb

@@ -0,0 +1,43 @@
+module Typetalk
+  class Api
+
+    module Auth
+      attr_accessor :authorization_code
+
+      def get_access_token(client_id:nil, client_secret:nil, grant_type:nil, scope:nil, code:nil, redirect_uri:nil)
+        body = {
+          client_id: client_id || Typetalk.config.client_id,
+          client_secret: client_secret || Typetalk.config.client_secret,
+          grant_type: grant_type || Typetalk.config.grant_type,
+          scope: scope || Typetalk.config.scope,
+        }
+
+        if body[:grant_type] == 'authorization_code'
+          body[:code] = code || @authorization_code
+          body[:redirect_uri] = redirect_uri || Typetalk.config.redirect_uri
+        end
+
+        response = connection.post do |req|
+         req.url 'https://typetalk.in/oauth2/access_token'
+         req.body = body
+        end
+        parse_response(response)
+      end
+
+
+      def self.authorize_url(client_id:nil, redirect_uri:nil, scope:nil)
+        params = {
+          client_id: client_id || Typetalk.config.client_id,
+          redirect_uri: redirect_uri || Typetalk.config.redirect_uri,
+          scope: scope || Typetalk.config.scope,
+          response_type: 'code',
+        }
+        url = URI.parse('https://typetalk.in/oauth2/authorize')
+        url.query = URI.encode_www_form(params)
+        url.to_s
+      end
+
+    end
+
+  end
+end

data/lib/typetalk/api/mention.rb

@@ -0,0 +1,28 @@
+module Typetalk
+  class Api
+
+    module Mention
+
+      def get_mentions(token:nil, from:nil, unread:nil)
+        response = connection.get do |req|
+          req.url "#{endpoint}/mentions"
+          req.params[:access_token] = token || access_token
+          req.params[:from] = from unless from.nil?
+          req.params[:unread] = unread unless unread.nil?
+        end
+        parse_response(response)
+      end
+
+
+      def read_mention(mention_id, token:nil)
+        response = connection.put do |req|
+          req.url "#{endpoint}/mentions/#{mention_id}"
+          req.params[:access_token] = token || access_token
+        end
+        parse_response(response)
+      end
+
+    end
+
+  end
+end