mattermost-ruby 0.1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2dbd77cb69baccb0f56d2a2b2671ee3e602e5d52
+  data.tar.gz: e78806366fcee69bcb32fb63ba09791633d2f415
+SHA512:
+  metadata.gz: 5c943f34990584343f93103fd4022fbe2ad3cbf41ae1003d8d87a9827e4de142c23e0bdf612f0030cef4b849ccc48d81ffebdc55decef21bf3875d87e5ee1e4b
+  data.tar.gz: 9de2faac62461b67d860c814139b306b3d80d6d28dd09faf9ed09470ab4aa53eab55e9ffc8c004a424e0d7431c1fd40a4af0024a96486024a1f7db717d61e3fc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'httparty'
+gem 'pry'

data/README.md

@@ -0,0 +1,50 @@
+# Mattermost-Ruby
+
+An ActiveRecord-inspired API client for Mattermost
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mattermost'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mattermost
+
+## Configuration
+
+```
+options = {:httparty => {:debug_output => $stdout} } # pass defaults to httparty
+
+Mattermost.connect("apiuser", "apipassword", "https://mattermost.example.com/api/v1", "default_team_name", options)
+
+users = Mattermost::User.all
+
+users.last.class #User
+
+users.last.reset_password("newpassword")
+
+users.last.id # abcdefgh12345678
+
+Mattermost::User.find("abcdefgh12345678") 
+
+Mattermost::User.find_by(:email => "me@example.com") # <#User ...> 
+```
+
+## Todo
+
+Documentation.
+
+Tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshmn/mattermost-ruby.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :spec
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/mattermost/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mattermost"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mattermost.rb

@@ -0,0 +1,40 @@
+#require "mattermost/version"
+
+require 'httparty'
+require 'pry'
+
+require_relative 'mattermost/mattermost_object'
+require_relative 'mattermost/models/base'
+require_relative 'mattermost/team'
+require_relative 'mattermost/user'
+require_relative 'mattermost/admin'
+require_relative 'mattermost/channel'
+
+module Mattermost
+
+  include HTTParty
+
+  attr_accessor :team
+
+  class NotImplementedError < StandardError; end
+
+  def self.connect(username, password, server, team_name, options = {})
+    self.base_uri server
+    request = self.post('/users/login',
+                            :body => { :name => team_name, :username => username, :password => password}.to_json )
+    self.headers "Cookie" => "MMTOKEN=#{request.headers['token']}"
+    self.headers "X-Requested-With" => 'XMLHttpRequest'
+    @team = Team.new({:id => request.parsed_response['team_id'], :name => team_name})
+    options[:httparty].each do |k,v|
+      self.send(k, v)
+    end
+    unless options[:preload_user] == false
+      Mattermost::User.all
+    end
+  end
+
+  def self.team
+    @team
+  end
+
+end

data/lib/mattermost/admin.rb

@@ -0,0 +1,68 @@
+module Mattermost
+  class Admin < MattermostObject
+
+    def self.get_logs
+      Mattermost.get("/admin/logs")
+    end
+
+    def self.get_all_audits
+      Mattermost.get("/admin/audits")
+    end
+
+    def self.get_config
+      Mattermost.get("/admin/config")
+    end
+
+    def self.save_config
+      Mattermost.post("/admin/save_config")
+    end
+
+    def self.test_email
+      Mattermost.post("/admin/test_email")
+    end
+
+    def self.get_client_config
+      Mattermost.get("/admin/client_props")
+    end
+
+    def self.log_client
+      Mattermost.post("/admin/log_client")
+    end
+
+    def self.get_analytics(name, id = nil)
+      uri = "/admin/analytics"
+      uri += "/#{id}" if id
+      uri += "/#{name}"
+      Mattermost.get(uri)
+    end
+
+    def self.save_compliance_report
+      Mattermost.post("/admin/save_compliance_report")
+    end
+
+    def self.get_compliance_reports
+      Mattermost.get("/admin/compliance_reports")
+    end
+
+    def self.download_compliance_report(id)
+      Mattermost.get("/admin/download_compliance_report/#{id}")
+    end
+
+    def self.upload_brand_image
+      Mattermost.post("/admin/upload_brand_image")
+    end
+
+    def self.get_brand_image
+      Mattermost.get("/admin/get_brand_image")
+    end
+
+    def self.admin_reset_mfa
+      Mattermost.post("/admin/reset_mfa")
+    end
+
+    def self.admin_reset_password
+      Mattermost.post("/admin/reset_password")
+    end
+
+  end
+end

data/lib/mattermost/channel.rb

@@ -0,0 +1,44 @@
+module Mattermost
+  class Channel < MattermostObject
+
+    def self.new(attributes = {})
+      ::Channel.new(attributes)
+    end
+
+    # Returns all channels for the current team
+    #
+    # @param force_refresh [boolean] to recache the channels
+    def self.all(force_refresh = false)
+      @channels = nil if force_refresh
+      @channels ||= all_channels
+    end
+
+    # Returns "more" channels for the current team
+    def self.more
+      Mattermost.get("/channels/more")
+    end
+
+    # Returns a hash of counts for each *team*
+    # {"counts"=>{"ps6kdfuk9p8mjx6pkr3krgq3by"=>58334, "yckjbepc4frbmmq9in6tap1dwa"=>32},
+    #  "update_times"=>{"ps6kdfuk9p8mjx6pkr3krgq3by"=>1463180151709, "yckjbepc4frbmmq9in6tap1dwa"=>1457216806189}}
+    def self.counts
+      Mattermost.get("/channels/counts")
+    end
+
+    def self.create_direct(attributes = {})
+      raise NotImplementedError
+      Mattermost.post("/channels/create_direct")
+    end
+
+    protected
+    def self.all_channels
+      channels = []
+      request = Mattermost.get("/channels/")
+      request.parsed_response['channels'].each do |channel|
+        channels << self.new(channel)
+      end
+      channels
+    end
+
+  end
+end

data/lib/mattermost/mattermost_object.rb

@@ -0,0 +1,31 @@
+module Mattermost
+  class MattermostObject #:nodoc: all
+
+    def initialize
+    end
+
+    class << self
+      def method_missing(method_id, *args) #:nodoc:
+        o = self.new
+        o.send(method_id, *args)
+      rescue HTTParty::UnsupportedURIScheme
+        raise "You must set Mattermost.connect before calling #{self.inspect}##{method_id}"
+      end
+    end
+
+    def connected?
+      self.class.base_uri
+    end
+
+    def self.before_method(*names)
+      names.each do |name|
+        m = name # public_class_method(name)
+        define_method(name) do |*args, &block|
+          yield
+          m.bind(self).(*args, &block)
+        end
+      end
+    end
+
+  end
+end

data/lib/mattermost/models/base.rb

@@ -0,0 +1,36 @@
+class Base
+
+  def initialize(attrs)
+    attrs.each do |k,v|
+      singleton_class.class_eval { attr_accessor "#{k}" }
+      instance_variable_set "@#{k.to_sym}", v
+    end
+  end
+
+  def attributes
+    return self.class.default_attributes unless defined?(@id)
+    hash = {}
+    self.instance_variables.each do |v|
+      hash[v.to_s.gsub('@', '').to_sym] = instance_variable_get(v)
+    end
+    hash
+  end
+
+  def last
+    eval("Mattermost::#{self.class}").all.last
+  end
+
+  def first
+    eval("Mattermost::#{self.class}").all.first
+  end
+
+  def to_json
+    attributes.to_json
+  end
+
+end
+
+require_relative 'team'
+require_relative 'user'
+require_relative 'channel'
+require_relative 'post'

data/lib/mattermost/models/channel.rb

@@ -0,0 +1,98 @@
+class Channel < Base
+
+  def save
+    defined?(self.id) ? update : create_channel
+  end
+
+  # Delete a channel
+  def delete
+    Mattermost.post("/channels/#{self.id}/delete")
+  end
+
+  # Get channel info
+  def info
+    Mattermost.get("/channels/#{self.id}/")
+  end
+
+  # Get the users in a channel
+  def get_channel_extra_info(member_limit = nil)
+    uri = "/channels/#{self.id}/extra_info"
+    uri += "/#{member_limit}" if member_limit
+    request = Mattermost.get(uri)
+    response = {}
+    response['id'] = request.parsed_response['id']
+    response['member_count'] = request.parsed_response['member_count']
+    response['members'] = []
+    request.parsed_response['members'].each do |user|
+      response['members'] << User.new(user)
+    end
+    response
+  end
+  alias_method :users, :get_channel_extra_info
+
+  # Join the channel with your authenticated user
+  # If you're looking to add a user to a channel, see #add_member
+  def join
+    Mattermost.post("/channels/#{self.id}/join")
+  end
+
+  # Leave the channel with your authenticated user
+  # If you're looking to remove a user from a channel, see #remove_member
+  def leave
+    Mattermost.post("/channels/#{self.id}/leave")
+  end
+
+  # Add a user to a channel
+  # Send a user object or a user_id
+  def add_member(user)
+    user_id = user.is_a? User ? user.id : user
+    Mattermost.post("/channels/#{self.id}/add", :body => {:user_id => user_id})
+  end
+
+  # Add a user to a channel
+  # Send a user object or a user_id
+  def remove_member(user)
+    user_id = user.is_a? User ? user.id : user
+    Mattermost.post("/channels/#{self.id}/remove", :body => {:user_id => user_id})
+  end
+
+  def update_last_viewed_at
+    Mattermost.post("/channels/#{self.id}/update_last_viewed_at")
+  end
+
+  def update_attributes(attributes = {})
+    raise NotImplementedError
+    Mattermost.post("/channels/update")
+  end
+
+  # Update the channel's header. I really hate that they have a specific
+  # method for this.
+  def update_header(header)
+    Mattermost.post("/channels/update_header", :body => {:channel_id => self.id, :channel_header => header})
+  end
+
+  # Update the channel's purpose. I really hate that they have a specific
+  # method for this.
+  def update_purpose(purpose)
+    Mattermost.post("/channels/update_purpose", :body => {:channel_id => self.id, :channel_purpose => purpose})
+  end
+
+  def self.default_attributes
+    {:display_name => String, :team_id => String, :type => Integer, :purpose => String}
+  end
+
+  def posts
+    request = Mattermost.get("/channels/#{self.id}/posts/0/60?_=#{Time.now.to_i}")
+    response = {}
+    request.parsed_response['posts'].each do |k, v|
+      response[k] = Post.new(v)
+    end
+    response
+  end
+
+  protected
+  def create_channel
+    `curl '#{Mattermost.base_uri}/channels/create' -H 'Cookie: MMTOKEN=#{Mattermost.headers['Cookie'].split("=")[1]};' -H 'X-Requested-With: XMLHttpRequest' --data-binary '{"display_name":"#{self.display_name}","name":"#{self.display_name.gsub(" ", '-')}","team_id":"#{Mattermost.team.id}","purpose":"#{self.purpose}.","type":"#{self.type}"}' --compressed`
+  end
+
+end

data/lib/mattermost/models/post.rb

@@ -0,0 +1,9 @@
+class Post < Base
+  attr_accessor :user
+
+  def initialize(attributes)
+    super(attributes)
+    @user = Mattermost::User.find(attributes['user_id'])
+  end
+
+end

data/lib/mattermost/models/team.rb

@@ -0,0 +1,6 @@
+class Team < Base
+
+  def add_user(user)
+    Mattermost.post("/teams/#{Mattermost.team.id}/add_user_to_team", :body => { :user_id => user.id })
+  end
+end

data/lib/mattermost/models/user.rb

@@ -0,0 +1,16 @@
+class User < Base
+
+  def reset_password(new_password)
+    payload = {:name => Mattermost.team.name, :user_id => self.id, :new_password => new_password}
+    Mattermost.post("/users/reset_password", :body => payload.to_json)
+  end
+
+  def status
+    Mattermost::User.status([self.id])[self.id]
+  end
+
+  def preferences
+    Mattermost.get("/preferences")
+  end
+
+end

data/lib/mattermost/team.rb

@@ -0,0 +1,25 @@
+module Mattermost
+  class Team < MattermostObject
+
+    def self.new(attributes = {})
+      ::Team.new(attributes)
+    end
+
+    def self.all(force_refresh = false)
+      @teams = nil if force_refresh
+      @teams ||= all_teams
+    end
+
+    protected
+    def self.all_teams
+      teams = []
+      request = Mattermost.get("/teams/all")
+      request.parsed_response.values.each do |team|
+        teams << self.new(team)
+      end
+      teams
+    end
+
+  end
+end
+

data/lib/mattermost/user.rb

@@ -0,0 +1,47 @@
+module Mattermost
+  class User < MattermostObject
+
+    def self.new(attributes = {})
+      ::User.new(attributes)
+    end
+
+    def self.all(force_refresh = false)
+      @users = nil if force_refresh
+      @users ||= all_users
+    end
+
+    # Return a user that matches a given attribute.
+    # Common pairs are :email => email, or :username => username
+    # Return nil if not no matches
+    def self.find_by(opts = {})
+      all.select { |user| user.send(opts.keys.first) == opts.values.first }.first
+    end
+
+    # Return the user that has an id of @param id
+    def self.find(id)
+      find_by(:id => id)
+    end
+
+    # Return the status of users
+    # Statuses are "offline", "away", or "online"
+    def self.status(user_ids = [])
+      Mattermost.post("/users/status", :body => user_ids.to_json)
+    end
+
+    # Returns the user that was used for authentication on Mattermost.connect
+    def self.me
+      request = Mattermost.get("/users/me")
+      self.new(request.parsed_response)
+    end
+
+    protected
+    def self.all_users
+      users = []
+      request = Mattermost.get("/users/profiles")
+      request.parsed_response.values.each do |user|
+        users << self.new(user)
+      end
+      users
+    end
+  end
+end

data/lib/mattermost/version.rb

@@ -0,0 +1,3 @@
+module Mattermost
+  VERSION = "0.1.0.1"
+end

data/mattermost.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mattermost/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mattermost-ruby'
+  spec.version       = Mattermost::VERSION
+  spec.authors       = ['Josh Brody']
+  spec.email         = ['josh@josh.mn']
+  spec.platform      = Gem::Platform::RUBY
+  spec.licenses      = ['MIT']
+  spec.authors       = ['Josh Brody']
+  spec.summary       = %q{An ActiveModel-inspired API client for Mattermost}
+  spec.description   = %q{An ActiveModel-inspired API client for Mattermost}
+  spec.homepage      = 'https://github.com/joshmn/mattermost-ruby'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mattermost-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0.1
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: An ActiveModel-inspired API client for Mattermost
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mattermost.rb
+- lib/mattermost/admin.rb
+- lib/mattermost/channel.rb
+- lib/mattermost/mattermost_object.rb
+- lib/mattermost/models/base.rb
+- lib/mattermost/models/channel.rb
+- lib/mattermost/models/post.rb
+- lib/mattermost/models/team.rb
+- lib/mattermost/models/user.rb
+- lib/mattermost/team.rb
+- lib/mattermost/user.rb
+- lib/mattermost/version.rb
+- mattermost.gemspec
+homepage: https://github.com/joshmn/mattermost-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.3
+signing_key: 
+specification_version: 4
+summary: An ActiveModel-inspired API client for Mattermost
+test_files: []