mattermost-api4-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae6ca1e3c233e6d6c953582635f23895b506cab8
+  data.tar.gz: d9e8fd4c84e5a4bd54884e7084bd7f0e0f83d7dc
+SHA512:
+  metadata.gz: 3e130e395c64901f8d7d99b39abb882db95b6baa45c3aaddd6fa9d64f0958053ac97fc9c62214aebc9a5908146b615417997aa0399fa24554bd0cae91ee0ea06
+  data.tar.gz: a0a16200c978cf328be7c5d9a5cdc172aabf23ff9c2915a5ae1f893d893ddf3648f28f0e5bedaa3b100f16889f4eeb380cef9eed89cdaec6b877d66ebcb20b15

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Takayuki Maruyama
+
+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,39 @@
+# mattermost-api4-ruby
+
+Mattermost API v4 client for ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mattermost-api4-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mattermost-api4-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/maruTA-bis5/mattermost-api4-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mattermost-api4"
+
+# 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,8 @@
+require_relative 'mattermost/client'
+
+module Mattermost
+
+	def new_client(server)
+		Mattermost::Client.new server
+	end
+end

data/lib/mattermost/client.rb

@@ -0,0 +1,44 @@
+require 'httparty'
+require_relative 'endpoint'
+require_relative 'request'
+
+module Mattermost
+
+	class Client
+		import Mattermost::Endpoint
+		import Mattermost::Request
+
+		attr_accessor :server, :token
+
+		def initialize(server)
+			self.server = server
+			self.base_uri = "#{server}/api/v4"
+		end
+
+		def login(username, password)
+			login_request = post('/users/login', :body => {:login_id => uername, :password => password}.to_json)
+			self.token = login_request.headers['token']
+			update_token
+		end
+
+		def logout
+			self.token = nil
+			update_token
+		end
+
+		def use_access_token(token)
+			self.token = token
+			update_token
+		end
+
+		def connected?
+			getMe().success?
+		end
+
+		private
+
+		def update_token
+			self.headers "Authorization: Bearer #{token}"
+		end
+	end
+end

data/lib/mattermost/endpoint.rb

@@ -0,0 +1,51 @@
+require_relative 'endpoint/brand'
+require_relative 'endpoint/channels'
+require_relative 'endpoint/cluster'
+require_relative 'endpoint/commands'
+require_relative 'endpoint/compliance'
+require_relative 'endpoint/data_retention'
+require_relative 'endpoint/elasticsearch'
+require_relative 'endpoint/emoji'
+require_relative 'endpoint/files'
+require_relative 'endpoint/jobs'
+require_relative 'endpoint/ldap'
+require_relative 'endpoint/oauth'
+require_relative 'endpoint/open_graph'
+require_relative 'endpoint/plugins'
+require_relative 'endpoint/posts'
+require_relative 'endpoint/preferences'
+require_relative 'endpoint/reactions'
+require_relative 'endpoint/saml'
+require_relative 'endpoint/status'
+require_relative 'endpoint/system'
+require_relative 'endpoint/teams'
+require_relative 'endpoint/users'
+require_relative 'endpoint/webhooks'
+
+module Mattermost
+	module Endpoint
+		include Brand
+		include Channels
+		include Cluster
+		include Commands
+		include Compliance
+		include DataRetention
+		include Elasticsearch
+		include Emoji
+		include Files
+		include Jobs
+		include LDAP
+		include OAuth
+		include OpenGraph
+		include Plugins
+		include Posts
+		include Preferences
+		include Reactions
+		include SAML
+		include Status
+		include System
+		include Teams
+		include Users
+		include Webhooks
+	end
+end

data/lib/mattermost/endpoint/brand.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module Mattermost
+	module Endpoint
+		module Brand
+
+			def get_brand_image(file_name)
+				File.open(file_name, "w") do |file|
+					file.binmode
+					get(get_brand_image_url(), stream_body: true) do |fragment|
+						file.write(fragment)
+					end
+				end
+			end
+
+			def get_brand_image_url
+				"/brand/image"
+			end
+
+			def upload_brand_image(image_file)
+				#post("/brand/image", image_file)
+				raise NotImplementedError
+			end
+
+		end
+	end
+end

data/lib/mattermost/endpoint/channels.rb

@@ -0,0 +1,118 @@
+require 'json'
+
+module Mattermost
+	module Endpoint
+		module Channels
+			def create_channel(channel = {})
+				post("/channels", :body => channels.to_json)
+			end
+
+			def create_direct_channel(user_id_1, user_id_2)
+				post("/channels/direct", :body => JSON.generate([user_id_1, user_id_2]))
+			end
+
+			def create_group_message(user_ids = [])
+				post("/channels/group", :body => JSON.generate(user_ids))
+			end
+
+			def get_channel_list_by_ids(team_id, channel_ids = [])
+				post("/teams/#{team_id}/channels/ids", :body => JSON.generate(channel_ids))
+			end
+
+			def get_channel(channel_id)
+				get("/channels/#{channel_id}")
+			end
+
+			def update_channel(channel_id, channel = {})
+				put("/channels/#{channel_id}", channel.to_json)
+			end
+
+			def delete_channel(channel_id)
+				delete("/channels/#{channel_id}")
+			end
+
+			def patch_channel(channel_id, patch = {})
+				put("/channels/#{channel_id}/patch", patch.to_json)
+			end
+
+			def restore_channel(channel_id)
+				post("/channels/#{channel_id}/restore")
+			end
+
+			def get_channel_stats(channel_id)
+				get("/channels/#{channel_id}/stats")
+			end
+
+			def get_pinned_posts(channel_id)
+				get("/channels/#{channel_id}/pinned")
+			end
+
+			def get_public_channels(team_id, max = 60)
+				get("/teams/#{team_id}/channels?per_page=#{max}")
+			end
+
+			def get_deleted_channels(team_id, max = 60)
+				get("/teams/#{team_id}/channels/deleted?per_page=#{max}")
+			end
+
+			def search_channels(team_id, term)
+				post("/teams/#{team_id}/channels/search", :body => {:term => term}.to_json)
+			end
+
+			def get_channel_by_name(team_id, channel_name)
+				get("/teams/#{team_id}/channels/name/#{channel_name}")
+			end
+
+			def get_channel_by_name_and_team_name(team_name, channel_name)
+				get("/teams/name/#{team_name}/channels/name/#{channel_name}")
+			end
+
+			def get_channel_members(channel_id, max = 60)
+				get("/channels/#{channel_id}/members?per_page=#{max}")
+			end
+
+			def add_user_to_channel(channel_id, user_id)
+				post("/channels/#{channel_id}/members", :body => {:user_id => user_id}.to_json)
+			end
+
+			def get_channel_members_by_ids(channel_id, user_ids = [])
+				post("/channels/#{channel_id}/members/ids", :body => JSON.generate(user_ids))
+			end
+
+			def get_channel_member(channel_id, user_id)
+				get("/channels/#{channel_id}/members/#{user_id}")
+			end
+
+			def remove_user_from_channel(channel_id, user_id)
+				delete("/channels/#{channel_id}/members/#{user_id}")
+			end
+
+			def update_channel_roles(channel_id, user_id, roles)
+				put("/channels/#{channel_id}/members/#{user_id}/roles", :body => {:roles => roles}.to_json)
+			end
+
+			def update_channel_notifications(channel_id, user_id, notify_props = {})
+				put("/channels/#{channel_id}/members/#{user_id}/notify_props", notify_props.to_json)
+			end
+
+			def view_channel(user_id, channel_id, prev_channel_id)
+				post("/channels/members/#{user_id}/view", :body => {
+					:channel_id => channel_id,
+					:prev_channel_id => prev_channel_id
+				}.to_json)
+			end
+
+			def get_channel_members_for_user(user_id, team_id)
+				get("/users/#{user_id}/teams/#{team_id}/channels/members")
+			end
+
+			def get_channels_for_user(user_id, team_id)
+				get("/users/#{user_id}/teams/#{team_id}/channels")
+			end
+
+			def get_unread_messages(user_id, channel_id)
+				get("/users/#{user_id}/channels/#{channel_id}/unread")
+			end
+		end
+	end
+end

data/lib/mattermost/endpoint/cluster.rb

@@ -0,0 +1,12 @@
+require 'json'
+
+module Mattermost
+	module Endpoint
+		module Cluster
+
+			def get_cluster_status
+				get("/cluster/status")
+			end
+		end
+	end
+end

data/lib/mattermost/endpoint/commands.rb

@@ -0,0 +1,39 @@
+require 'json'
+
+module Mattermost
+	module Endpoint
+		module Commands
+
+			def create_command(command)
+				post("/commands", :body => command.to_json)
+			end
+
+			def list_commands(team_id, custom_only = false)
+				get("/commands?team_id=#{team_id}&custom_only#{custom_only}")
+			end
+
+			def list_autocomplete_commands(team_id)
+				get("/teams/#{team_id}/commands/autocomplete")
+			end
+
+			def update_command(command_id, command)
+				put("/commands/#{command_id}", :body => command.to_json)
+			end
+
+			def delete_command(command_id)
+				delete("/commands/#{command_id}")
+			end
+
+			def regenerate_command_token(command_id)
+				put("/commands/#{command_id}/regen_token")
+			end
+
+			def execute_command(channel_id, command)
+				post("/commands/execute", :body => {
+					:channel_id => channel_id,
+					:command => command
+				}.to_json)
+			end
+		end
+	end
+end

data/lib/mattermost/endpoint/compliance.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module Mattermost
+	module Endpoint
+		module Compliance
+
+			def create_compliance_report
+				post("/compliance/reports")
+			end
+
+			def get_compliance_reports(max = 60)
+				get("/compliance/reports?per_page=#{max}")
+			end
+
+			def get_compliance_report(report_id)
+				get("/compliance/reports/#{report_id}")
+			end
+
+			def download_compliance_report(report_id, file_name)
+				File.open(file_name, "w") do |file|
+					file.binmode
+					get(download_compliance_report_url(report_id), stream_body: true) do |fragment|
+						file.write(fragment)
+					end
+				end
+			end
+
+			def download_compliance_report_url(report_id)
+				"/compliance/reports/#{report_id}/download"
+			end
+		end
+	end
+end