zoomba 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 4ccb608bd278f3d69ab5eaf5033b5bbb0c8b83dc
4
+ data.tar.gz: 8f73e87266ea93492e473c4eff47ecd24d995322
5
+ SHA512:
6
+ metadata.gz: 02375e6fd8a4e3e5c09e98b2bf65cf508bcc158f3c6a60d8b5f775a595a84472d710f3df9791eac1dc4f4a4b3c869718a8886157b68ae2ddf0191322d3865d20
7
+ data.tar.gz: 2549f3040e15e4e9545b9ead5d96523502022db95bddf920196d5eb8b416e2a1ff99f7a517aca4301abbd5a8667452ecb11d1849e47218fe3311beac15155b4b
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ /.idea/*
11
+ .rspec_status
12
+ coverage_report.sh
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.0
5
+ before_install: gem install bundler -v 1.14.6
data/Gemfile ADDED
@@ -0,0 +1,8 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :test do
6
+ gem "simplecov"
7
+ gem "codeclimate-test-reporter", "~> 1.0.0"
8
+ end
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Krzysztof Rygielski
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,75 @@
1
+ ![travis status](https://travis-ci.org/riggy/zoomba.svg?branch=master)
2
+ [![Code Climate](https://codeclimate.com/github/riggy/zoomba/badges/gpa.svg)](https://codeclimate.com/github/riggy/zoomba)
3
+ [![Test Coverage](https://codeclimate.com/github/riggy/zoomba/badges/coverage.svg)](https://codeclimate.com/github/riggy/zoomba/coverage)
4
+ [![Issue Count](https://codeclimate.com/github/riggy/zoomba/badges/issue_count.svg)](https://codeclimate.com/github/riggy/zoomba)
5
+
6
+ # Zoomba
7
+
8
+ Zoomba is implementation of Zoom.us API, loosely inspired by [zoomus gem](https://github.com/mllocs/zoomus).
9
+
10
+ It aims to provide object mapping for Zoom.us data and convenient methods to interact with those data and the API.
11
+
12
+ ## Supported API endpoints
13
+
14
+ So far gem supports the following Zoom.us endpoints:
15
+
16
+ * /user/create
17
+ * /user/autocreate
18
+ * /user/custcreate
19
+ * /user/ssocreate
20
+ * /user/list
21
+ * /user/pending
22
+ * /user/get
23
+ * /user/getbyemail
24
+ * /user/checkemail
25
+ * /user/checkzpk
26
+ * /user/delete
27
+ * /user/deactivate
28
+ * /user/update
29
+ * /user/updatepassword
30
+ * /user/revoketoken
31
+ * /user/permanentdelete
32
+
33
+
34
+ ## Installation
35
+
36
+ Add this line to your application's Gemfile:
37
+
38
+ ```ruby
39
+ gem 'zoomba'
40
+ ```
41
+
42
+ And then execute:
43
+
44
+ $ bundle
45
+
46
+ Or install it yourself as:
47
+
48
+ $ gem install zoomba
49
+
50
+ ## Usage
51
+
52
+ First configure Zoomba with this code:
53
+
54
+ Zoomba.configure do |c|
55
+ c.api_key = API_KEY
56
+ c.api_secret = API_SECRET
57
+ end
58
+
59
+ Then, for example, to fetch all users:
60
+
61
+ Zoomba::User.list
62
+
63
+ It will return a collection of `Zoomba::User` instances.
64
+
65
+ More usage tips to follow...
66
+
67
+ ## Contributing
68
+
69
+ Bug reports and pull requests are welcome on GitHub at https://github.com/riggy/zoomba. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
70
+
71
+
72
+ ## License
73
+
74
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
75
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rake/testtask'
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << 'test'
6
+ t.libs << 'lib'
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task default: :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'zoomba'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/zoomba.rb ADDED
@@ -0,0 +1,28 @@
1
+ require 'net/http'
2
+ require 'json'
3
+ require 'ostruct'
4
+
5
+ require 'zoomba/error'
6
+ require 'zoomba/base'
7
+ require 'zoomba/collection'
8
+ require 'zoomba/configuration'
9
+ require 'zoomba/user'
10
+ require 'zoomba/version'
11
+
12
+ module Zoomba
13
+ class << self
14
+ attr_reader :configuration
15
+
16
+ def configure
17
+ @configuration ||= Configuration.new
18
+ yield(@configuration)
19
+ end
20
+
21
+ def configuration
22
+ if @configuration.nil? || !@configuration.complete?
23
+ raise Zoomba::Error::NoConfiguration
24
+ end
25
+ @configuration
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,45 @@
1
+ module Zoomba
2
+ class Base < OpenStruct
3
+ def assign(args = {})
4
+ args.each do |key, value|
5
+ next if key.to_sym == :id
6
+ send("#{key}=", value)
7
+ end
8
+ self
9
+ end
10
+
11
+ def self.perform_request(action, data = {})
12
+ uri = URI("#{Zoomba.configuration.api_base_url}/#{resource_path_part}/#{action}")
13
+ response = Net::HTTP.start(uri.host,
14
+ uri.port,
15
+ use_ssl: true) do |http|
16
+ request = Net::HTTP::Post.new(uri)
17
+ request.set_form_data(Zoomba.configuration.to_h.merge(data))
18
+ http.request(request)
19
+ end
20
+
21
+ process_response(response)
22
+ end
23
+
24
+ def perform_request(action, data = {})
25
+ self.class.perform_request(action, data)
26
+ end
27
+
28
+ def self.process_response(response)
29
+ if response.code == '200'
30
+ parsed = JSON.parse(response.body)
31
+ return parsed if parsed['error'].nil?
32
+ raise Error::ApiError.new(parsed['error']['message'],
33
+ parsed['error']['code'])
34
+ end
35
+ end
36
+
37
+ def self.resource_path_part
38
+ to_s.downcase.sub('zoomba::', '')
39
+ end
40
+
41
+ def resource_path_part
42
+ self.class.resource_path_part
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,8 @@
1
+
2
+ module Zoomba
3
+ class Collection < Array
4
+ def initialize(api_response, type = nil)
5
+ super(api_response[type.to_s].map { |u| Zoomba::User.new(u) })
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,20 @@
1
+ module Zoomba
2
+ class Configuration
3
+ attr_accessor :api_key, :api_secret, :api_base_url
4
+
5
+ def initialize
6
+ @api_base_url = 'https://api.zoom.us/v1'
7
+ end
8
+
9
+ def complete?
10
+ !@api_key.nil? && !@api_secret.nil?
11
+ end
12
+
13
+ def to_h
14
+ {
15
+ api_key: @api_key,
16
+ api_secret: @api_secret
17
+ }
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,23 @@
1
+ module Zoomba
2
+ module Error
3
+ class NoConfiguration < StandardError
4
+ def initialize(msg = 'Please provide Zoom.us credentials.')
5
+ super
6
+ end
7
+ end
8
+
9
+ class RequiredParametersMissing < StandardError
10
+ def initialize(*params)
11
+ super("Api parameters are missing (#{params.join(', ')})")
12
+ end
13
+ end
14
+
15
+ class ApiError < StandardError
16
+ attr_reader :code
17
+ def initialize(msg = 'Zoom API error', code = nil)
18
+ @code = code
19
+ super(msg)
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,107 @@
1
+ module Zoomba
2
+ class User < Zoomba::Base
3
+ class << self
4
+ def create(args = {})
5
+ validate_params(args, :email, :type)
6
+ new(perform_request(:create, args))
7
+ end
8
+
9
+ def autocreate(args = {})
10
+ validate_params(args, :email, :type, :password)
11
+ new(perform_request(:autocreate, args))
12
+ end
13
+
14
+ def custcreate(args = {})
15
+ validate_params(args, :email, :type)
16
+ new(perform_request(:custcreate, args))
17
+ end
18
+
19
+ def ssocreate(args = {})
20
+ validate_params(args, :email, :type)
21
+ new(perform_request(:ssocreate, args))
22
+ end
23
+
24
+ def list(args = {})
25
+ Zoomba::Collection.new(perform_request(:list, args), :users)
26
+ end
27
+
28
+ def pending(args = {})
29
+ Zoomba::Collection.new(perform_request(:pending, args), :users)
30
+ end
31
+
32
+ def get(args = {})
33
+ validate_params(args, :id)
34
+ new(perform_request(:get, args))
35
+ end
36
+
37
+ def getbyemail(args = {})
38
+ validate_params(args, :email, :login_type)
39
+ new(perform_request(:getbyemail, args))
40
+ end
41
+
42
+ def checkemail(args = {})
43
+ validate_params(args, :email)
44
+ response = perform_request(:checkemail, args)
45
+ response['existed_email']
46
+ end
47
+
48
+ def checkzpk(args = {})
49
+ validate_params(args, :zpk)
50
+ response = perform_request(:checkzpk, args)
51
+ response['expire_in']
52
+ end
53
+
54
+ def validate_params(params = {}, *expected)
55
+ missing = []
56
+ expected.each do |param|
57
+ missing << param if params[param].nil? || params[param].empty?
58
+ end
59
+ raise Zoomba::Error::RequiredParametersMissing, missing if missing.any?
60
+ end
61
+ end
62
+
63
+ def delete
64
+ validate_presence_of :id
65
+ assign(perform_request(:delete, id: id))
66
+ end
67
+
68
+ def deactivate
69
+ validate_presence_of :id
70
+ assign(perform_request(:deactivate, id: id))
71
+ end
72
+
73
+ def update(args = {})
74
+ validate_presence_of :id
75
+ assign(args)
76
+ assign(perform_request(:update, args.merge(id: id)))
77
+ end
78
+
79
+ def updatepassword(args = {})
80
+ validate_params(args.merge(id: id), :id, :password)
81
+ assign(perform_request(:updatepassword, args.merge(id: id)))
82
+ end
83
+
84
+ def revoketoken
85
+ validate_presence_of :id
86
+ assign(perform_request(:revoketoken, id: id))
87
+ end
88
+
89
+ def permanentdelete
90
+ validate_presence_of :id
91
+ assign(perform_request(:permanentdelete, id: id))
92
+ end
93
+
94
+ def get
95
+ validate_presence_of :id
96
+ assign(perform_request(:get, id: id))
97
+ end
98
+
99
+ private
100
+
101
+ def validate_presence_of(param)
102
+ if send(param).nil? || send(param).empty?
103
+ raise Zoomba::Error::RequiredParametersMissing, [param]
104
+ end
105
+ end
106
+ end
107
+ end
@@ -0,0 +1,3 @@
1
+ module Zoomba
2
+ VERSION = '0.1.0'.freeze
3
+ end
data/zoomba.gemspec ADDED
@@ -0,0 +1,31 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'zoomba/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'zoomba'
8
+ spec.version = Zoomba::VERSION
9
+ spec.authors = ['Krzysztof Rygielski']
10
+ spec.email = ['krzysztof@rygiel.net']
11
+
12
+ spec.summary = 'Zoom.us API implementation'
13
+ spec.homepage = 'https://github.com/riggy/zoomba'
14
+ spec.license = 'MIT'
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = 'exe'
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ['lib']
22
+
23
+ spec.add_development_dependency 'bundler', '~> 1.14'
24
+ spec.add_development_dependency 'rake', '~> 10.0'
25
+ spec.add_development_dependency "rspec", "~> 3.0"
26
+ spec.add_development_dependency 'webmock', '~> 2.3'
27
+ spec.add_development_dependency 'pry'
28
+ spec.add_development_dependency 'awesome_print'
29
+
30
+ spec.add_runtime_dependency 'json'
31
+ end
metadata ADDED
@@ -0,0 +1,158 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: zoomba
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Krzysztof Rygielski
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-04-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.14'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: webmock
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '2.3'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '2.3'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: awesome_print
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: json
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ description:
112
+ email:
113
+ - krzysztof@rygiel.net
114
+ executables: []
115
+ extensions: []
116
+ extra_rdoc_files: []
117
+ files:
118
+ - ".gitignore"
119
+ - ".travis.yml"
120
+ - Gemfile
121
+ - LICENSE.txt
122
+ - README.md
123
+ - Rakefile
124
+ - bin/console
125
+ - bin/setup
126
+ - lib/zoomba.rb
127
+ - lib/zoomba/base.rb
128
+ - lib/zoomba/collection.rb
129
+ - lib/zoomba/configuration.rb
130
+ - lib/zoomba/error.rb
131
+ - lib/zoomba/user.rb
132
+ - lib/zoomba/version.rb
133
+ - zoomba.gemspec
134
+ homepage: https://github.com/riggy/zoomba
135
+ licenses:
136
+ - MIT
137
+ metadata: {}
138
+ post_install_message:
139
+ rdoc_options: []
140
+ require_paths:
141
+ - lib
142
+ required_ruby_version: !ruby/object:Gem::Requirement
143
+ requirements:
144
+ - - ">="
145
+ - !ruby/object:Gem::Version
146
+ version: '0'
147
+ required_rubygems_version: !ruby/object:Gem::Requirement
148
+ requirements:
149
+ - - ">="
150
+ - !ruby/object:Gem::Version
151
+ version: '0'
152
+ requirements: []
153
+ rubyforge_project:
154
+ rubygems_version: 2.6.8
155
+ signing_key:
156
+ specification_version: 4
157
+ summary: Zoom.us API implementation
158
+ test_files: []