clicksend_client 5.1.2 → 5.1.4

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.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +96 -43
  4. data/clicksend_client.gemspec +8 -12
  5. data/lib/clicksend_client/version.rb +1 -1
  6. metadata +26 -106
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8710003887757734478c96ac7f0459d46e9ed84ff270363f16eaf5bcf39dcafe
4
- data.tar.gz: f13e18c099f99f46a70d64f3e6e7b3bf13fcf2dac3b66bef02978a08312d1544
3
+ metadata.gz: 22defa57f778797619ad88acb3642e162ce37459b07e41d1b9ba39ca75c0023e
4
+ data.tar.gz: 4d03fb206d074cf54d15a77a52a267d72bd51dd0c5d4f1cb352977360ab0119e
5
5
  SHA512:
6
- metadata.gz: fc17cec86575094e44a1778c2fb544ea1cb0ca55eddcf4dbd370ca1851e098b30fd7e68fb9f3a1d753c325241fabfe1a29111ccb01d6dfbbccc39c6f8da90693
7
- data.tar.gz: d19fcc2154b886b77eeef6163bf9733dfd7dfc77928b36a78e52becc19de0b32d535e655df3a2fe1ee99b655a4c01a4596026d5e5c3fb5dbe0a117faa761e890
6
+ metadata.gz: c4a0db93e40289f1cfee124d854c9face1276d8fdf76251d99cc5ce54301130339785510d167a559d5d811c5bac8a66ef76cae95dede4c1bde71d26feebbbaf7
7
+ data.tar.gz: a3a811465409e3079087bf6e7210a879054f227dfb5f192e6428f392c5d1b3f85381c87699e7c6343b866dbe450773a7a87d63fda47568e61637d0deae32375e
data/Gemfile CHANGED
@@ -3,5 +3,5 @@ source 'https://rubygems.org'
3
3
  gemspec
4
4
 
5
5
  group :development, :test do
6
- gem 'rake', '~> 12.3.3'
6
+ gem 'rake', '~> 13.2', '>= 13.2.0'
7
7
  end
data/README.md CHANGED
@@ -1,84 +1,137 @@
1
- # The official ruby library for ClickSend v3 API
1
+ # The official Ruby SDK for ClickSend v3 API
2
2
 
3
-
4
- This is the official [ClickSend](https://clicksend.com) SDK. Documentation can be found [here](https://developers.clicksend.com/docs/rest/v3/?ruby#introduction).
3
+ This is the official [ClickSend](https://clicksend.com) Ruby SDK. Full API documentation can be found [here](https://developers.clicksend.com/docs/rest/v3/?ruby#introduction).
5
4
 
6
5
  ## Requirements
7
6
 
8
- - [Sign Up](https://www.clicksend.com/signup) for a free ClickSend account.
9
- - Copy your API key from the [API Credentials](https://dashboard.clicksend.com/#/account/subaccount) area.
7
+ - Ruby >= 2.7 (install via [Homebrew](https://brew.sh): `brew install ruby`)
8
+ - Bundler (`gem install bundler`)
9
+ - A [ClickSend account](https://dashboard.clicksend.com/#/signup/step1/) with an API key
10
10
 
11
11
  ## Installation
12
12
 
13
- ### Build a gem
13
+ Add the gem to your `Gemfile`:
14
14
 
15
- To build the Ruby code into a gem:
15
+ ```ruby
16
+ source 'https://rubygems.org'
16
17
 
17
- ```shell
18
- gem build clicksend_client.gemspec
18
+ gem 'clicksend_client', '~> 1.0.0'
19
19
  ```
20
20
 
21
- Then either install the gem locally:
21
+ Then install:
22
22
 
23
- ```shell
24
- gem install ./clicksend_client-1.0.0.gem
23
+ ```bash
24
+ bundle install
25
25
  ```
26
- (for development, run `gem install --dev ./clicksend_client-1.0.0.gem` to install the development dependencies)
27
-
28
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
29
-
30
- Finally add this to the Gemfile:
31
-
32
- gem 'clicksend_client', '~> 1.0.0'
33
26
 
34
27
  ### Install from Git
35
28
 
36
- If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
37
-
38
- gem 'clicksend_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
39
-
40
- ### Include the Ruby code directly
41
-
42
- Include the Ruby code directly using `-I` as follows:
43
-
44
- ```shell
45
- ruby -Ilib script.rb
29
+ ```ruby
30
+ gem 'clicksend_client', git: 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
46
31
  ```
47
32
 
48
33
  ## Getting Started
49
34
 
50
- Please follow the [installation](#installation) procedure and then run the following code:
51
35
  ```ruby
52
- # Load the gem
36
+ #!/usr/bin/env ruby
37
+ # frozen_string_literal: true
38
+
53
39
  require 'clicksend_client'
54
40
 
55
- # Setup authorization
41
+ # — Credentials ————————————————————————————————————————————————————————————————
42
+ USERNAME = 'your_username'
43
+ API_KEY = 'your_api_key'
44
+
45
+ # — Message details ————————————————————————————————————————————————————————————
46
+ FROM_NUMBER = '' # E.164 format e.g. "+61400000000", or leave empty for default sender ID
47
+ TO_NUMBER = '+61411111111' # Recipient in E.164 format
48
+ MESSAGE = 'Hello from ClickSend Ruby SDK!'
49
+
50
+ # — Configure the client ———————————————————————————————————————————————————————
56
51
  ClickSendClient.configure do |config|
57
- # Configure HTTP basic authorization: BasicAuth
58
- config.username = 'YOUR USERNAME'
59
- config.password = 'YOUR PASSWORD'
52
+ config.username = USERNAME
53
+ config.password = API_KEY
60
54
  end
61
55
 
62
- api_instance = ClickSendClient::AccountApi.new
56
+ # — Build and send the SMS —————————————————————————————————————————————————————
57
+ sms_message = ClickSendClient::SmsMessage.new(
58
+ to: TO_NUMBER,
59
+ from: FROM_NUMBER,
60
+ body: MESSAGE,
61
+ source: 'ruby'
62
+ )
63
+
64
+ collection = ClickSendClient::SmsMessageCollection.new(messages: [sms_message])
63
65
 
64
66
  begin
65
- #Get account information
66
- result = api_instance.account_get
67
- p result
67
+ api = ClickSendClient::SMSApi.new
68
+ response = api.sms_send_post(collection)
69
+ puts "Success: #{response}"
68
70
  rescue ClickSendClient::ApiError => e
69
- puts "Exception when calling AccountApi->account_get: #{e}"
71
+ puts "API error: #{e.message}"
72
+ puts "Response body: #{e.response_body}" if e.respond_to?(:response_body)
70
73
  end
74
+ ```
75
+
76
+ You can find your API key in the [ClickSend Dashboard](https://dashboard.clicksend.com) under **Account > API Credentials**.
77
+
78
+ ## Usage
71
79
 
80
+ ```bash
81
+ bundle exec ruby send_sms.rb
72
82
  ```
73
83
 
84
+ A successful response looks like:
85
+
86
+ ```json
87
+ {
88
+ "http_code": 200,
89
+ "response_code": "SUCCESS",
90
+ "response_msg": "Messages queued for delivery.",
91
+ "data": {
92
+ "total_price": 0.891,
93
+ "total_count": 1,
94
+ "queued_count": 1,
95
+ "messages": [
96
+ {
97
+ "status": "SUCCESS",
98
+ "to": "+61411111111",
99
+ "from": "ClickSend",
100
+ "body": "Hello from ClickSend Ruby SDK!",
101
+ "message_price": "0.8910",
102
+ "carrier": "Telstra",
103
+ "country": "AU"
104
+ }
105
+ ]
106
+ }
107
+ }
108
+ ```
109
+
110
+ ## Upgrading the SDK
111
+
112
+ Update the version in your `Gemfile`, then run:
113
+
114
+ ```bash
115
+ bundle update clicksend_client
116
+ ```
117
+
118
+ Available versions are listed on [RubyGems](https://rubygems.org/gems/clicksend_client/versions).
119
+
74
120
  ## Documentation
75
121
 
76
- Documentation for our SDK and REST API can be found [here](https://developers.clicksend.com/docs/rest/v3/?ruby#introduction).
122
+ Full SDK and REST API documentation: [developers.clicksend.com](https://developers.clicksend.com/docs/rest/v3/?ruby#introduction)
77
123
 
78
- ## Documentation for Authorization
124
+ ## Authorization
79
125
 
80
126
 
81
127
  ### BasicAuth
82
128
 
83
- - **Type**: HTTP basic authentication
129
+ - **Type**: HTTP basic authentication — pass your ClickSend username and API key as `config.username` / `config.password`
130
+
131
+
132
+ ## Resources
84
133
 
134
+ - [ClickSend Ruby SDK on RubyGems](https://rubygems.org/gems/clicksend_client)
135
+ - [ClickSend REST API v3 Docs](https://developers.clicksend.com/docs/rest/v3/)
136
+ - [ClickSend Dashboard](https://dashboard.clicksend.com)
137
+ - [Support](https://help.clicksend.com)
data/clicksend_client.gemspec CHANGED
@@ -24,20 +24,16 @@ Gem::Specification.new do |s|
24
24
  s.homepage = "https://github.com/clicksend-api/clicksend-codegen"
25
25
  s.summary = "ClickSend v3 API Ruby Gem"
26
26
  s.description = " This is an official SDK for [ClickSend](https://clicksend.com) Below you will find a current list of the available methods for clicksend. *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* "
27
- s.license = "Unlicense"
27
+ s.license = "MIT"
28
28
  s.required_ruby_version = ">= 2.7"
29
29
 
30
- s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
- s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
- s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.0'
33
-
34
- s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
35
- s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
36
- s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
37
- s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
38
- s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
39
- s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
40
- s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
30
+ s.add_runtime_dependency 'typhoeus', '~> 1.4', '>= 1.4.0'
31
+ s.add_runtime_dependency 'json', '~> 2.7', '>= 2.7.0'
32
+ s.add_runtime_dependency 'addressable', '~> 2.8', '>= 2.8.0'
33
+
34
+ s.add_development_dependency 'rspec', '~> 3.13', '>= 3.13.0'
35
+ s.add_development_dependency 'vcr', '~> 6.2', '>= 6.2.0'
36
+ s.add_development_dependency 'webmock', '~> 3.23', '>= 3.23.0'
41
37
 
42
38
  s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
43
39
  s.test_files = `find spec/*`.split("\n")
data/lib/clicksend_client/version.rb CHANGED
@@ -11,5 +11,5 @@ ClickSend Codegen version: 2.4.53-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module ClickSendClient
14
- VERSION = '5.1.2'
14
+ VERSION = '5.1.4'
15
15
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: clicksend_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.1.2
4
+ version: 5.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - ClickSend-Codegen
@@ -15,200 +15,120 @@ dependencies:
15
15
  requirements:
16
16
  - - "~>"
17
17
  - !ruby/object:Gem::Version
18
- version: '1.0'
18
+ version: '1.4'
19
19
  - - ">="
20
20
  - !ruby/object:Gem::Version
21
- version: 1.0.1
21
+ version: 1.4.0
22
22
  type: :runtime
23
23
  prerelease: false
24
24
  version_requirements: !ruby/object:Gem::Requirement
25
25
  requirements:
26
26
  - - "~>"
27
27
  - !ruby/object:Gem::Version
28
- version: '1.0'
28
+ version: '1.4'
29
29
  - - ">="
30
30
  - !ruby/object:Gem::Version
31
- version: 1.0.1
31
+ version: 1.4.0
32
32
  - !ruby/object:Gem::Dependency
33
33
  name: json
34
34
  requirement: !ruby/object:Gem::Requirement
35
35
  requirements:
36
36
  - - "~>"
37
37
  - !ruby/object:Gem::Version
38
- version: '2.1'
38
+ version: '2.7'
39
39
  - - ">="
40
40
  - !ruby/object:Gem::Version
41
- version: 2.1.0
41
+ version: 2.7.0
42
42
  type: :runtime
43
43
  prerelease: false
44
44
  version_requirements: !ruby/object:Gem::Requirement
45
45
  requirements:
46
46
  - - "~>"
47
47
  - !ruby/object:Gem::Version
48
- version: '2.1'
48
+ version: '2.7'
49
49
  - - ">="
50
50
  - !ruby/object:Gem::Version
51
- version: 2.1.0
51
+ version: 2.7.0
52
52
  - !ruby/object:Gem::Dependency
53
53
  name: addressable
54
54
  requirement: !ruby/object:Gem::Requirement
55
55
  requirements:
56
56
  - - "~>"
57
57
  - !ruby/object:Gem::Version
58
- version: '2.3'
58
+ version: '2.8'
59
59
  - - ">="
60
60
  - !ruby/object:Gem::Version
61
- version: 2.3.0
61
+ version: 2.8.0
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: '2.3'
68
+ version: '2.8'
69
69
  - - ">="
70
70
  - !ruby/object:Gem::Version
71
- version: 2.3.0
71
+ version: 2.8.0
72
72
  - !ruby/object:Gem::Dependency
73
73
  name: rspec
74
74
  requirement: !ruby/object:Gem::Requirement
75
75
  requirements:
76
76
  - - "~>"
77
77
  - !ruby/object:Gem::Version
78
- version: '3.6'
78
+ version: '3.13'
79
79
  - - ">="
80
80
  - !ruby/object:Gem::Version
81
- version: 3.6.0
81
+ version: 3.13.0
82
82
  type: :development
83
83
  prerelease: false
84
84
  version_requirements: !ruby/object:Gem::Requirement
85
85
  requirements:
86
86
  - - "~>"
87
87
  - !ruby/object:Gem::Version
88
- version: '3.6'
88
+ version: '3.13'
89
89
  - - ">="
90
90
  - !ruby/object:Gem::Version
91
- version: 3.6.0
91
+ version: 3.13.0
92
92
  - !ruby/object:Gem::Dependency
93
93
  name: vcr
94
94
  requirement: !ruby/object:Gem::Requirement
95
95
  requirements:
96
96
  - - "~>"
97
97
  - !ruby/object:Gem::Version
98
- version: '3.0'
98
+ version: '6.2'
99
99
  - - ">="
100
100
  - !ruby/object:Gem::Version
101
- version: 3.0.1
101
+ version: 6.2.0
102
102
  type: :development
103
103
  prerelease: false
104
104
  version_requirements: !ruby/object:Gem::Requirement
105
105
  requirements:
106
106
  - - "~>"
107
107
  - !ruby/object:Gem::Version
108
- version: '3.0'
108
+ version: '6.2'
109
109
  - - ">="
110
110
  - !ruby/object:Gem::Version
111
- version: 3.0.1
111
+ version: 6.2.0
112
112
  - !ruby/object:Gem::Dependency
113
113
  name: webmock
114
114
  requirement: !ruby/object:Gem::Requirement
115
115
  requirements:
116
116
  - - "~>"
117
117
  - !ruby/object:Gem::Version
118
- version: '1.24'
118
+ version: '3.23'
119
119
  - - ">="
120
120
  - !ruby/object:Gem::Version
121
- version: 1.24.3
121
+ version: 3.23.0
122
122
  type: :development
123
123
  prerelease: false
124
124
  version_requirements: !ruby/object:Gem::Requirement
125
125
  requirements:
126
126
  - - "~>"
127
127
  - !ruby/object:Gem::Version
128
- version: '1.24'
128
+ version: '3.23'
129
129
  - - ">="
130
130
  - !ruby/object:Gem::Version
131
- version: 1.24.3
132
- - !ruby/object:Gem::Dependency
133
- name: autotest
134
- requirement: !ruby/object:Gem::Requirement
135
- requirements:
136
- - - "~>"
137
- - !ruby/object:Gem::Version
138
- version: '4.4'
139
- - - ">="
140
- - !ruby/object:Gem::Version
141
- version: 4.4.6
142
- type: :development
143
- prerelease: false
144
- version_requirements: !ruby/object:Gem::Requirement
145
- requirements:
146
- - - "~>"
147
- - !ruby/object:Gem::Version
148
- version: '4.4'
149
- - - ">="
150
- - !ruby/object:Gem::Version
151
- version: 4.4.6
152
- - !ruby/object:Gem::Dependency
153
- name: autotest-rails-pure
154
- requirement: !ruby/object:Gem::Requirement
155
- requirements:
156
- - - "~>"
157
- - !ruby/object:Gem::Version
158
- version: '4.1'
159
- - - ">="
160
- - !ruby/object:Gem::Version
161
- version: 4.1.2
162
- type: :development
163
- prerelease: false
164
- version_requirements: !ruby/object:Gem::Requirement
165
- requirements:
166
- - - "~>"
167
- - !ruby/object:Gem::Version
168
- version: '4.1'
169
- - - ">="
170
- - !ruby/object:Gem::Version
171
- version: 4.1.2
172
- - !ruby/object:Gem::Dependency
173
- name: autotest-growl
174
- requirement: !ruby/object:Gem::Requirement
175
- requirements:
176
- - - "~>"
177
- - !ruby/object:Gem::Version
178
- version: '0.2'
179
- - - ">="
180
- - !ruby/object:Gem::Version
181
- version: 0.2.16
182
- type: :development
183
- prerelease: false
184
- version_requirements: !ruby/object:Gem::Requirement
185
- requirements:
186
- - - "~>"
187
- - !ruby/object:Gem::Version
188
- version: '0.2'
189
- - - ">="
190
- - !ruby/object:Gem::Version
191
- version: 0.2.16
192
- - !ruby/object:Gem::Dependency
193
- name: autotest-fsevent
194
- requirement: !ruby/object:Gem::Requirement
195
- requirements:
196
- - - "~>"
197
- - !ruby/object:Gem::Version
198
- version: '0.2'
199
- - - ">="
200
- - !ruby/object:Gem::Version
201
- version: 0.2.12
202
- type: :development
203
- prerelease: false
204
- version_requirements: !ruby/object:Gem::Requirement
205
- requirements:
206
- - - "~>"
207
- - !ruby/object:Gem::Version
208
- version: '0.2'
209
- - - ">="
210
- - !ruby/object:Gem::Version
211
- version: 0.2.12
131
+ version: 3.23.0
212
132
  description: " This is an official SDK for [ClickSend](https://clicksend.com) Below
213
133
  you will find a current list of the available methods for clicksend. *NOTE: You
214
134
  will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* "
@@ -484,7 +404,7 @@ files:
484
404
  - spec/spec_helper.rb
485
405
  homepage: https://github.com/clicksend-api/clicksend-codegen
486
406
  licenses:
487
- - Unlicense
407
+ - MIT
488
408
  metadata: {}
489
409
  rdoc_options: []
490
410
  require_paths: