cloverrb 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: 581f5ae1a03e3a6fff40f406e6dbd6c6af195725
4
+ data.tar.gz: c249d9884d2ff50cde1d4d7e2f10b40c8666ff80
5
+ SHA512:
6
+ metadata.gz: 5822dfaca3c0fbe785e1e37e3093be8400cfc23e6e3f3f07e30ebf115853761a3ff091e55c191ee434ff53686a5e93976c0f86b51941537f132e8c26f6ccb13b
7
+ data.tar.gz: 873faee27deb16d413c9d941c4ed12d8e1d873beb582558c3ca47b1e8a46ce0959d421c2ec31ad48361fae579186b93d71829bc9cdb3dd90d25d4fa761e1107f
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
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.1
5
+ before_install: gem install bundler -v 1.15.1
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in cloverrb.gemspec
4
+ gemspec
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # Cloverrb
2
+
3
+ This is a ruby wrapper for the [Clover API - US](https://www.clover.com/api_docs/).
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'cloverrb'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install cloverrb
20
+
21
+ ## Usage
22
+
23
+ ### Requirements:
24
+ - Token (Generated via OAuth)
25
+ - Merchant Code
26
+
27
+ ### Merchants
28
+ > Get all merchant details
29
+ ```ruby
30
+ merchant_client = Cloverrb::Merchant(token)
31
+ merchant_client.find(merchant_id)
32
+ ```
33
+
34
+ ### Employees
35
+ > Get a list of employees of a specific merchant
36
+ ```ruby
37
+ employees_client = Cloverrb::Employee(token)
38
+ employees_client.all(merchant_id)
39
+ ```
40
+
41
+ ## Contributing
42
+
43
+ Bug reports and pull requests are welcome on GitHub at https://github.com/iamarmanjon/cloverrb.
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "cloverrb"
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/cloverrb.gemspec ADDED
@@ -0,0 +1,32 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "cloverrb/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "cloverrb"
8
+ spec.version = Cloverrb::VERSION
9
+ spec.authors = ["Arman Jon Villalobos"]
10
+ spec.email = ["me@armanjon.com"]
11
+
12
+ spec.summary = %q{Ruby wrapper for Clover API}
13
+ spec.description = %q{Ruby wrapper for Clover API}
14
+ spec.homepage = ""
15
+ spec.license = "MIT"
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.15"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec", "~> 3.0"
26
+ spec.add_development_dependency "vcr"
27
+ spec.add_development_dependency "webmock"
28
+ spec.add_development_dependency "pry"
29
+
30
+ spec.add_dependency "httparty"
31
+ spec.add_dependency "dotenv"
32
+ end
@@ -0,0 +1,31 @@
1
+ module Cloverrb
2
+ class Client
3
+ BASE_URL = "https://api.clover.com/v3"
4
+
5
+ def get(token, path)
6
+ HTTParty.get(BASE_URL + path, headers: build_headers(token)).parsed_response
7
+ end
8
+
9
+ def post(token, path, body)
10
+ HTTParty.post(
11
+ BASE_URL + path,
12
+ headers: build_headers(token),
13
+ query: body
14
+ ).parsed_response
15
+ end
16
+
17
+ def put(token, path, body)
18
+ HTTParty.put(
19
+ BASE_URL + path,
20
+ headers: build_headers(token),
21
+ query: body
22
+ ).parsed_response
23
+ end
24
+
25
+ private
26
+
27
+ def build_headers(token)
28
+ { "Authorization" => "Bearer #{token}"}
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,14 @@
1
+ module Cloverrb
2
+ class Employee < Client
3
+ def initialize(token, merchant_code)
4
+ @token = token
5
+ @merchant_code = merchant_code
6
+ end
7
+
8
+ def all(role=nil)
9
+ url = "/merchants/#{@merchant_code}/employees"
10
+ url += "?filter=role=#{role}" if role
11
+ response = get(@token, url)
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,12 @@
1
+ module Cloverrb
2
+ class Merchant < Client
3
+ def initialize(token)
4
+ @token = token
5
+ end
6
+
7
+ def find(merchant_id)
8
+ url = "/merchants/#{merchant_id}"
9
+ response = get(@token, url)
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,3 @@
1
+ module Cloverrb
2
+ VERSION = "0.1.0"
3
+ end
data/lib/cloverrb.rb ADDED
@@ -0,0 +1,10 @@
1
+ require "cloverrb/version"
2
+ require "httparty"
3
+ require "pry"
4
+ require_relative "cloverrb/client"
5
+ require_relative "cloverrb/merchant"
6
+ require_relative "cloverrb/employee"
7
+
8
+ module Cloverrb
9
+ # Your code goes here...
10
+ end
metadata ADDED
@@ -0,0 +1,170 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: cloverrb
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Arman Jon Villalobos
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-07-07 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.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
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: vcr
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: webmock
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: pry
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: httparty
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
+ - !ruby/object:Gem::Dependency
112
+ name: dotenv
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :runtime
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description: Ruby wrapper for Clover API
126
+ email:
127
+ - me@armanjon.com
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".gitignore"
133
+ - ".rspec"
134
+ - ".travis.yml"
135
+ - Gemfile
136
+ - README.md
137
+ - Rakefile
138
+ - bin/console
139
+ - bin/setup
140
+ - cloverrb.gemspec
141
+ - lib/cloverrb.rb
142
+ - lib/cloverrb/client.rb
143
+ - lib/cloverrb/employee.rb
144
+ - lib/cloverrb/merchant.rb
145
+ - lib/cloverrb/version.rb
146
+ homepage: ''
147
+ licenses:
148
+ - MIT
149
+ metadata: {}
150
+ post_install_message:
151
+ rdoc_options: []
152
+ require_paths:
153
+ - lib
154
+ required_ruby_version: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - ">="
157
+ - !ruby/object:Gem::Version
158
+ version: '0'
159
+ required_rubygems_version: !ruby/object:Gem::Requirement
160
+ requirements:
161
+ - - ">="
162
+ - !ruby/object:Gem::Version
163
+ version: '0'
164
+ requirements: []
165
+ rubyforge_project:
166
+ rubygems_version: 2.6.12
167
+ signing_key:
168
+ specification_version: 4
169
+ summary: Ruby wrapper for Clover API
170
+ test_files: []