mattermost 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7f10f5417d0d540624ada8368d8946046da3ccd
+  data.tar.gz: e07a277a4c5533801f0d7851845bb6daf6d97bcc
+SHA512:
+  metadata.gz: 68a92ac6c5b99010b19625e720266622e422469ec1e5021644c22b9938108547312b0cb4b2d2c789265680aa49da2d3ad0727d2aed04825f339ad99637963560
+  data.tar.gz: 797960faa2b5c5c10673e3d534fba1511ac72d881a74d0a315b1bc913b6fbd4b3d9dfd2c414ae58844f4cbd6020e9d9c27d96ce8e9c2b36530fd09512d746278

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mm.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    mattermost (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    method_source (0.9.0)
+    multi_xml (0.6.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mattermost!
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Josh Brody
+
+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,63 @@
+# Mattermost
+
+A rewrite of Mattermost-Ruby to be more elegant. And it's kind of cool.
+
+## Notes
+
+This is for v4 and forward. For v3, please use the original Mattermost-Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mattermost'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mattermost
+
+## Usage
+
+Don't use this yet. But it requires Mattermost version 4.
+
+## Authentication
+
+You'll want to create a user that has some system-wide roles within Mattermost.
+
+    Mattermost.configure do |c|
+      c.server = 'great-company.com'
+      c.protocol = 'https'
+      c.username = 'joshmn'
+      c.password = 'password'
+    end
+    
+    Mattermost.connect!
+
+Without calling `connect!` you won't have the headers required to make the API calls, so call it somewhere once.
+
+## Conventions
+
+Inspired by the Active Record pattern ActionDispatch routes (member/collection), you can,
+
+    User.find(user_id).teams
+
+to get a User's teams.
+
+Or, 
+
+    User.create(mattermost_params)
+
+to create a user.
+
+All the corresponding methods are defined inside lib/mattermost/resources. Of note,
+
+* Methods that have an `as` of `self` are class-level methods, and `member` are instance-level methods.
+* The `args` option allows this client to map the passed arguments to a variable for usage in the HTTP request (`body` does the same thing, but for the body of the request)
+* If an `endpoint` option has `:variable`, that's indicative of needing to pass an argument to the method.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mm"
+
+# 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(__FILE__)

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,41 @@
+require 'mattermost/version'
+require 'mattermost/client'
+require 'mattermost/dsl'
+require 'mattermost/request_builder'
+require 'mattermost/resource_name'
+require 'mattermost/resources/base'
+require 'mattermost/resources/team'
+require 'mattermost/resources/user'
+
+module Mattermost
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Config.new
+    yield(configuration)
+  end
+
+  class Config
+    attr_accessor :server, :protocol, :username, :password
+
+    def initialize
+      @server = ""
+      @protocol = "https"
+      @username = ""
+      @password = ""
+    end
+
+    def raw_host
+      "#{Mattermost.configuration.protocol}://#{Mattermost.configuration.server}"
+    end
+
+  end
+
+  def self.connect!
+    Client.connect!
+  end
+
+end

data/lib/mattermost/client.rb

@@ -0,0 +1,18 @@
+require 'httparty'
+
+module Mattermost
+  class Client
+    include HTTParty
+
+    def self.connect!
+      req = HTTParty.post("#{Mattermost.configuration.protocol}://#{Mattermost.configuration.server}/api/v4/users/login", :body => {:login_id => Mattermost.configuration.username, :password => Mattermost.configuration.password}.to_json)
+      if req.success?
+        class_eval do
+          base_uri "#{Mattermost.configuration.protocol}://#{Mattermost.configuration.server}/api/v4"
+          headers 'Cookie' => req.headers['set-cookie'], 'X-Requested-With' => 'XMLHttpRequest'
+        end
+      end
+    end
+
+  end
+end

data/lib/mattermost/dsl.rb

@@ -0,0 +1,64 @@
+module Mattermost
+  module DSL
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def get(endpoint_name, options = {})
+        options[:resource] = self.resource_name
+        create_api_method(:get, endpoint_name, options)
+      end
+
+      def post(endpoint_name, options = {})
+        options[:resource] = self.resource_name
+        create_api_method(:post, endpoint_name, options)
+      end
+
+      def put(endpoint_name, options = {})
+        options[:resource] = self.resource_name
+        create_api_method(:post, endpoint_name, options.merge(:http_method => :put))
+      end
+
+      def delete(endpoint_name, options = {})
+        create_api_method(:delete, endpoint_name, options)
+      end
+
+      private
+
+      # /teams/name/:first_name/exists/:last_name
+      # arg should be :first_name, :last_name (in the order they appear)
+      def create_api_method(http_method, method_name, options = {})
+        options = normalize_options(options)
+        options[:http_method] ||= http_method
+        define_api_method(method_name, options)
+      end
+
+      def define_api_method(method_name, opts)
+        if opts[:as] == :self
+          define_singleton_method(method_name) do |*args|
+            builder = RequestBuilder.new(self, method_name, args, opts)
+            request = Client.send(opts[:http_method], "#{Mattermost.configuration.raw_host}/api/v4#{builder.endpoint}", builder.request_options)
+            request
+          end
+        else
+          define_method(method_name) do |*args|
+            builder = RequestBuilder.new(self, method_name, args, opts)
+            request = Client.send(opts[:http_method], "#{Mattermost.configuration.raw_host}/api/v4#{builder.endpoint}", builder.request_options)
+            request
+          end
+        end
+      end
+
+      def normalize_options(options)
+        options[:args] ||= []
+        options
+      end
+
+    end
+
+  end
+end
+
+

data/lib/mattermost/request_builder.rb

@@ -0,0 +1,133 @@
+module Mattermost
+  class RequestBuilder
+
+    def initialize(resource, method_name, args, options)
+      @resource = resource
+      @method_name = method_name
+      @args = args
+      @options = options
+    end
+
+    def interpolated_endpoint
+      raw = raw_endpoint
+      route_params = raw.scan(%r{(:\w*)}).flatten
+      route_params.each do |route_param|
+        rp = route_param[1..-1]
+        if @resource.respond_to?(rp.to_sym)
+          raw.gsub!(route_param, @resource.send(rp.to_sym))
+        elsif parameters[rp.to_sym]
+          raw.gsub!(route_param, parameters[rp.to_sym])
+        elsif endpoint_args_map[rp.to_sym]
+          raw.gsub!(route_param, endpoint_args_map[rp.to_sym])
+        end
+      end
+      unless query_params.empty?
+        raw += "?#{URI.encode_www_form(query_params)}"
+      end
+      raw
+    end
+
+    def request_options
+      if request_body
+        return {:body => request_body.to_json}
+      end
+      {}
+    end
+
+    alias_method :endpoint, :interpolated_endpoint
+
+    private
+
+    def raw_endpoint
+      if as == :member
+        return "/#{@options[:resource].plural}/:#{@options[:resource].param_key}/#{@method_name}" if @options[:endpoint].nil?
+        if @options[:endpoint] == ''
+          return "/#{@options[:resource].plural}/:#{@options[:resource].param_key}"
+        elsif @options[:endpoint].to_s[0] != '/'
+          return "/#{@options[:resource].plural}/:#{@options[:resource].param_key}/#{@options[:endpoint]}"
+        end
+      elsif as == :self
+        return "/#{@options[:resource].plural}/#{@method_name}" if @options[:endpoint].nil?
+        if @options[:endpoint] == ''
+          return "/#{@options[:resource].plural}"
+        elsif @options[:endpoint].to_s[0] != '/'
+          return "/#{@options[:resource].plural}/#{@options[:endpoint]}"
+        end
+      end
+    end
+
+    def parameters
+      if @args[0].is_a?(Hash)
+        @args[0]
+      else
+        extract_args
+      end
+    end
+
+    def args_from_options
+      if @options[:args].is_a?(Symbol)
+        [@options[:args]]
+      else
+        @options[:args]
+      end
+    end
+
+    def endpoint_args_map
+      map = {}
+      raw_endpoint.scan(%r{(:\w*)}).flatten.map { |p| p[1..-1].to_sym }.each_with_index do |arg, ind|
+        map[arg] = @args[ind]
+      end
+      map
+    end
+
+    def extract_args
+      arg_map = {}
+      args_from_options.each_with_index do |arg, ind|
+        arg_map[arg] = @args[ind]
+      end
+      arg_map
+    end
+
+    def supports_query_params?
+      @options[:http_method] == :get
+    end
+
+    def query_params
+      return {} unless supports_query_params?
+      return {} if @args.empty?
+      if @args[0].is_a?(Hash)
+        return @args[0]
+      end
+      {}
+    end
+
+    def body_map
+      if @options[:body]
+        arg_map = {}
+        [@options[:body]].each_with_index do |arg, ind|
+          arg_map[arg] = @args[ind]
+        end
+        return arg_map
+      end
+    end
+
+    def request_body
+      if @options[:body]
+        return body_map
+      end
+      if @args[0].is_a?(Hash)
+        return @args[0]
+      end
+      if @args[0].is_a?(String) && @args.is_a?(Array)
+        if as == :self
+          return @args
+        end
+      end
+      nil
+    end
+
+    def as
+      @options[:as]
+    end
+  end
+end

data/lib/mattermost/resource_name.rb

@@ -0,0 +1,30 @@
+module Mattermost
+  class ResourceName
+
+    attr_reader :klass
+    def initialize(klass)
+      @klass = if klass.name.index("::")
+                 klass.name.split("::").last
+               else
+                 klass.name
+               end
+    end
+
+    def singular
+      @klass.downcase
+    end
+
+    def plural
+      "#{@klass}s".downcase
+    end
+
+    def path
+      plural.downcase
+    end
+
+    def param_key
+      "#{singular}_id".downcase.to_sym
+    end
+
+  end
+end

data/lib/mattermost/resources/base.rb

@@ -0,0 +1,20 @@
+module Mattermost
+  class BaseResource
+
+    include Mattermost::DSL
+
+    attr_reader :id
+    def initialize(id)
+      @id = id
+    end
+
+    def self.find(id)
+      new(id)
+    end
+
+    def self.resource_name
+      ResourceName.new(self)
+    end
+
+  end
+end

data/lib/mattermost/resources/channel.rb

@@ -0,0 +1,11 @@
+module Mattermost
+  class Channel < BaseResource
+
+    alias_method :channel_id, :id
+
+    # Creates a channel
+    #   Channel.create(:team_id => "long-team-id", :name => "michaels-party", :display_name => "Michael's Party", :type => 'O')
+    post :create, :as => :self
+
+  end
+end

data/lib/mattermost/resources/team.rb

@@ -0,0 +1,51 @@
+module Mattermost
+  class Team < BaseResource
+
+    alias_method :team_id, :id
+
+    # Returns the given team
+    #   Team.find("long-team-id").raw
+    get :raw, :as => :member, :endpoint => ''
+
+    # Returns stats of a team
+    #   Team.find("long-team-id").stats
+    get :stats, :as => :member
+
+    # Returns a user by their name
+    #   Team.by_name("development")
+    get :by_name, :as => :self, :endpoint => 'name/:team_name', :args => :team_name
+
+    # Returns whether or not the team exists
+    #   Team.exists("party-planning-committee")
+    get :exists, :as => :self, :endpoint => 'name/:team_name/exists', :args => :team_name
+
+    # Returns all the teams on the instance
+    #   Team.all
+    get :all, :as => :self, :endpoint => ''
+
+    # Creates a team
+    #   Team.create(:name => "party-planning-committee", :display_name => "Party Planning Committee", type => 'I')
+    post :create, :as => :self, :endpoint => ''
+
+    # Search teams
+    #   Team.search("party")
+    post :search, :as => :self, :body => :term
+
+    # Gets members of a team
+    #   Team.find("long-team-id").members
+    get :members, :as => :member
+
+    # Adds a user to a Team
+    # Team.find("long-team-id").add_member(:team_id => "long-team-id", :user_id => "long-user-id", :roles => "team_admin")
+    post :add_member, :as => :member, :endpoint => 'members'
+
+    # Gets the member status of a user of a particiular team
+    # Team.find("long-team-id").member_by_user_id("long-user-id")
+    get :member_by_user_id, :as => :member, :endpoint => 'members/:user_id', :args => :user_id
+
+    # Updates a team
+    # Team.find("long-team-id").update_attributes(:display_name => "Former Party Planning Committee")
+    put :update_attributes, :as => :member, :endpoint => 'patch'
+
+  end
+end

data/lib/mattermost/resources/user.rb

@@ -0,0 +1,85 @@
+module Mattermost
+  class User < BaseResource
+
+    alias_method :user_id, :id
+
+    # Creates a user
+    #   User.create(:email => "ryan@dundermifflin.com", :username => "ryanhoward", :password => "ilovekelly")
+    post :create, :as => :self, :endpoint => ''
+
+    # Gets all users
+    #   User.all
+    get :all, :as => :self, :endpoint => ''
+
+    # Gets users by their user IDs
+    #   User.by_ids("long-user-id-1", "long-user-id-2")
+    post :by_ids, :as => :self, :endpoint => 'ids'
+
+    # Gets users by their usernames
+    #   User.by_usernames("long-username-1", "long-username-2")
+    post :by_usernames, :as => :self, :endpoint => 'usernames'
+
+    # Opens an autocomplete endpoint
+    # Requires :name; optional params are :team_id, :channel_id
+    # :name can be a username, nickname, first name, or last name
+    #   User.autocomplete(:name => "something")
+    get :autocomplete, :as => :self
+
+    # Returns the given user
+    #   User.find("long-user-id").raw
+    get :raw, :as => :member, :endpoint => ''
+
+    # Updates a user
+    #   User.find("long-user-id").update_attributes(:email => "ceo@dundermifflin.com")
+    put :update_attributes, :as => :member, :endpoint => 'patch'
+
+    # Updates the user's roles
+    #   User.find("long-user-id").roles("team_admin")
+    put :roles, :as => :member, :endpoint => 'roles', :args => :roles
+
+    # Gets the member's avatar/display pic thing
+    #   User.find("long-user-id").image
+    get :image, :as => :member
+
+    # Gets users by their username
+    #   User.by_username("ryan")
+    get :by_username, :as => :self, :endpoint => 'username/:username'
+
+    # Gets users with a matching email
+    get :by_email, :as => :self, :endpoint => 'email/:email'
+
+    # Gets current user sessions
+    get :sessions, :as => :member
+
+    # Revokes a given session
+    # User.find("long-user-id").revoke("session-id")
+    post :revoke_session, :as => :member, :endpoint => 'sessions/revoke', :args => :session_id
+
+    # Revokes all sessionds
+    post :revoke_all_sessions, :as => :member, :endpoint => 'sessions/revoke'
+
+    # Does an audit on the user
+    get :audits, :as => :member
+
+    # Verify the email used by a user to sign-up with
+    # User.verify("token")
+    post :verify_email, :as => :self, :endpoint => 'email/verify'
+
+    # Resend verification email
+    # User.send_verification_email("ryan@dundermifflin.com")
+    post :send_verification_email, :as => :self, :endpoint => 'email/verify/send', :body => :email
+
+    # Get the teams a user is a member of
+    # User.find("long-user-id").teams
+    get :teams, :as => :member
+
+    # ...
+    get :team_members, :as => :member, :endpoint => 'teams/members'
+
+
+
+    # These probably don't work
+    post :search, :as => :self, :endpoint => 'search' # this takes lots of args, should probably look at it
+    post :image, :as => :member # i haven't done files yet...this probably won't work
+  end
+end

data/lib/mattermost/version.rb

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

data/mattermost.gemspec

@@ -0,0 +1,28 @@
+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"
+  spec.version       = Mattermost::VERSION
+  spec.authors       = ["Josh Brody"]
+  spec.email         = ["josh@josh.mn"]
+
+  spec.summary       = "A slick Mattermost API client"
+  spec.description   = "A slick Mattermost API client"
+  spec.homepage      = "https://github.com/joshmn/mattermost"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: mattermost
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A slick Mattermost API client
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mattermost.rb
+- lib/mattermost/client.rb
+- lib/mattermost/dsl.rb
+- lib/mattermost/request_builder.rb
+- lib/mattermost/resource_name.rb
+- lib/mattermost/resources/base.rb
+- lib/mattermost/resources/channel.rb
+- lib/mattermost/resources/team.rb
+- lib/mattermost/resources/user.rb
+- lib/mattermost/version.rb
+- mattermost.gemspec
+homepage: https://github.com/joshmn/mattermost
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A slick Mattermost API client
+test_files: []