interfax 1.0.0.beta.2 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +22 -18
- data/lib/interfax/version.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 721e1f5a011b76e48aa02ff68d9b38c63f5949f0
|
4
|
+
data.tar.gz: 8567346eee96bd541e2b006cf97d9088b81cc042
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fc9ceefc4ca5c51c21d5a026d259a7172cfd4133e7ecafa5644db7b0eafe5ba750441de88f70112820bca64337fb57d02ffd19e740e990987cba478912941e48
|
7
|
+
data.tar.gz: 09471073db3a66ab250b303482f8591ef1da09ef4a99c9008c3a24bd181a054a00a3f71413dfa188cdb12bcc4035b7f1b2ded3b10ef15598eb2b8b3f38600b1a
|
data/README.md
CHANGED
@@ -8,7 +8,7 @@ Send and receive faxes in Ruby with the [InterFAX](https://www.interfax.net/en/d
|
|
8
8
|
|
9
9
|
## Installation
|
10
10
|
|
11
|
-
This gem requires 2.1+. You can install install it directly or via bundler.
|
11
|
+
This gem requires Ruby 2.1+. You can install install it directly or via bundler.
|
12
12
|
|
13
13
|
```ruby
|
14
14
|
gem 'interfax', '~> 1.0.0'
|
@@ -33,7 +33,7 @@ fax.status # Success if 0. Pending if < 0. Error if > 0
|
|
33
33
|
|
34
34
|
## Client
|
35
35
|
|
36
|
-
The client follows the [12-factor](12factor.net/config) apps principle and can be either set directly or via environment variables.
|
36
|
+
The client follows the [12-factor](http://12factor.net/config) apps principle and can be either set directly or via environment variables.
|
37
37
|
|
38
38
|
```ruby
|
39
39
|
# Initialize using parameters
|
@@ -92,7 +92,7 @@ fax.image # returns an image representing the fax sent to the faxNumber
|
|
92
92
|
fax.cancel # cancel the sending of the fax
|
93
93
|
```
|
94
94
|
|
95
|
-
Alternatively you can create an `InterFAX::File` with binary data and pass this in as well.
|
95
|
+
Alternatively you can create an [`InterFAX::File`](#interfaxfile) with binary data and pass this in as well.
|
96
96
|
|
97
97
|
```ruby
|
98
98
|
data = File.open('file://fax.pdf').read
|
@@ -100,13 +100,13 @@ file = interfax.files.create(data, mime_type: 'application/pdf')
|
|
100
100
|
interfax.outbound.deliver(faxNumber: "+11111111112", file: file)
|
101
101
|
```
|
102
102
|
|
103
|
-
To send multiple files just pass in an array strings and `InterFAX::File` objects.
|
103
|
+
To send multiple files just pass in an array strings and [`InterFAX::File`](#interfaxfile) objects.
|
104
104
|
|
105
105
|
```rb
|
106
106
|
interfax.outbound.deliver(faxNumber: "+11111111112", files: ['file://fax.pdf', 'https://s3.aws.com/example/fax.pdf'])
|
107
107
|
```
|
108
108
|
|
109
|
-
Under the hood every path and string is turned into a [InterFAX::File](#
|
109
|
+
Under the hood every path and string is turned into a [InterFAX::File](#interfaxfile) object. For more information see [the documentation](#interfaxfile) for this class.
|
110
110
|
|
111
111
|
**Options:** [`contact`, `postponeTime`, `retriesToPerform`, `csid`, `pageHeader`, `reference`, `pageSize`, `fitToPage`, `pageOrientation`, `resolution`, `rendering`](https://www.interfax.net/en/dev/rest/reference/2918)
|
112
112
|
|
@@ -142,7 +142,7 @@ interfax.outbound.completed(123, 234)
|
|
142
142
|
=> [#<InterFAX::Outbound::Fax>, ...]
|
143
143
|
```
|
144
144
|
|
145
|
-
**More:** [
|
145
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2972)
|
146
146
|
|
147
147
|
----
|
148
148
|
|
@@ -157,7 +157,7 @@ interfax.outbound.find(123456)
|
|
157
157
|
=> #<InterFAX::Outbound::Fax>
|
158
158
|
```
|
159
159
|
|
160
|
-
**More:** [
|
160
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2921)
|
161
161
|
|
162
162
|
----
|
163
163
|
|
@@ -176,7 +176,7 @@ image.save('fax.tiff')
|
|
176
176
|
=> # saves image to file
|
177
177
|
```
|
178
178
|
|
179
|
-
**More:** [
|
179
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2941)
|
180
180
|
|
181
181
|
----
|
182
182
|
|
@@ -191,7 +191,7 @@ interfax.outbound.cancel(123456)
|
|
191
191
|
=> #<InterFAX::Outbound::Fax>
|
192
192
|
```
|
193
193
|
|
194
|
-
**More:** [
|
194
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2939)
|
195
195
|
|
196
196
|
----
|
197
197
|
|
@@ -240,7 +240,7 @@ interfax.inbound.find(123456)
|
|
240
240
|
=> #<InterFAX::Inbound::Fax>
|
241
241
|
```
|
242
242
|
|
243
|
-
**More:** [
|
243
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2938)
|
244
244
|
|
245
245
|
---
|
246
246
|
|
@@ -259,7 +259,7 @@ image.save('fax.tiff')
|
|
259
259
|
=> # saves image to file
|
260
260
|
```
|
261
261
|
|
262
|
-
**More:** [
|
262
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2937)
|
263
263
|
|
264
264
|
---
|
265
265
|
|
@@ -274,7 +274,7 @@ interfax.inbound.email(123456)
|
|
274
274
|
=> [#<InterFAX::Email>]
|
275
275
|
```
|
276
276
|
|
277
|
-
**More:** [
|
277
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2930)
|
278
278
|
|
279
279
|
---
|
280
280
|
|
@@ -291,7 +291,7 @@ interfax.inbound.mark(123456, read: false) # mark unread
|
|
291
291
|
=> true
|
292
292
|
```
|
293
293
|
|
294
|
-
**More:** [
|
294
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2936)
|
295
295
|
|
296
296
|
---
|
297
297
|
|
@@ -310,7 +310,7 @@ interfax.inbound.resend(123456, email: 'test@example.com')
|
|
310
310
|
=> true
|
311
311
|
```
|
312
312
|
|
313
|
-
**More:** [
|
313
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2929)
|
314
314
|
|
315
315
|
---
|
316
316
|
|
@@ -318,7 +318,7 @@ interfax.inbound.resend(123456, email: 'test@example.com')
|
|
318
318
|
|
319
319
|
[Create](#create-document) | [Upload chunk](#upload-chunk) | [Get list](#get-document-list) | [Status](#get-document-status) | [Cancel](#cancel-document)
|
320
320
|
|
321
|
-
Document allow for uploading of large files up to 20MB in 200kb chunks. The `InterFAX::File` format automatically uses this if needed but a sample implementation would look as followed.
|
321
|
+
Document allow for uploading of large files up to 20MB in 200kb chunks. The [`InterFAX::File`](#interfaxfile) format automatically uses this if needed but a sample implementation would look as followed.
|
322
322
|
|
323
323
|
```ruby
|
324
324
|
file = File.open('test.pdf', 'rb')
|
@@ -360,7 +360,7 @@ interfax.documents.upload(123456, 0, 999, "....binary-data....")
|
|
360
360
|
=> true
|
361
361
|
```
|
362
362
|
|
363
|
-
**More:** [
|
363
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2966)
|
364
364
|
|
365
365
|
---
|
366
366
|
|
@@ -407,7 +407,7 @@ interfax.documents.cancel(123456)
|
|
407
407
|
=> true
|
408
408
|
```
|
409
409
|
|
410
|
-
**More:** [
|
410
|
+
**More:** [documentation](https://www.interfax.net/en/dev/rest/reference/2964)
|
411
411
|
|
412
412
|
---
|
413
413
|
|
@@ -516,6 +516,10 @@ document.id # Extracts the ID from the URI (the API does not return the ID)
|
|
516
516
|
4. **Push** your work back up to your fork
|
517
517
|
5. Submit a **Pull request** so that we can review your changes
|
518
518
|
|
519
|
-
|
519
|
+
## License
|
520
520
|
|
521
521
|
This library is released under the [MIT License](LICENSE).
|
522
|
+
|
523
|
+
## Credits
|
524
|
+
|
525
|
+
Many thanks go to [Sascha Brink](https://github.com/sbrink) for building the pre 1.0 version of this gem and supporting it for so many years.
|
data/lib/interfax/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: interfax
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.0
|
4
|
+
version: 1.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- InterFAX
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2016-08-
|
12
|
+
date: 2016-08-09 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: mimemagic
|
@@ -123,9 +123,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
123
123
|
version: '0'
|
124
124
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
125
125
|
requirements:
|
126
|
-
- - "
|
126
|
+
- - ">="
|
127
127
|
- !ruby/object:Gem::Version
|
128
|
-
version:
|
128
|
+
version: '0'
|
129
129
|
requirements: []
|
130
130
|
rubyforge_project:
|
131
131
|
rubygems_version: 2.5.1
|