apns-s3 0.0.1.alpha → 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.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -2
  3. data/lib/apns-s3.rb +3 -3
  4. data/lib/version.rb +1 -1
  5. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 01ecd75fce7fffdb559fada80b8846537747b67c
4
- data.tar.gz: a83d25810b2369d2854373153a77d4313f8e504c
3
+ metadata.gz: d63ea91a22d6f69812d67be24332b3b881c73653
4
+ data.tar.gz: 896a6cd43b253b874e6e564ff06567adf0bc1cd5
5
5
  SHA512:
6
- metadata.gz: 879be289ffca2abd8be1af372b44cad68ca2731bedd5b66d95744f6c86b84b5c7952c2975f4a9aebfcda7e4bd4ba0eabcbb7875edc7a6fdc1522690b6e63513e
7
- data.tar.gz: 59daf50809dab78d9a4b934fbdbbd3028fa52f5dae8a501b5294e3be71177b9d9c1f17ffd8d549a44d820eeadc5816698c328b8932879dd996d48211545e39af
6
+ metadata.gz: c67950d429f8afd8fe55603d25eda458da2b3716cfd18ff907dc977fbe27b08d7b6a9990f5729609d5b491ed3e7198c195425bc0728204862d7d05f0371fb3bc
7
+ data.tar.gz: bab41cabc2a5b7d649ea782b57a3e03ac6a4daa09311c09e03c380652397f9ab0da1c223a21e3df8a2a764e73bbf1269757e80281320333425bfce9560e28cd0
data/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  # Apns::S3
2
2
 
3
- TODO: Write a gem description
3
+ Download PEM file from AWS S3 and set APNS module.
4
+
5
+ This feature is useful on Heroku.
4
6
 
5
7
  ## Installation
6
8
 
@@ -20,7 +22,34 @@ Or install it yourself as:
20
22
 
21
23
  ## Usage
22
24
 
23
- TODO: Write usage instructions here
25
+ ```ruby
26
+ require 'apns-s3'
27
+
28
+ ApnsS3.set_pemfile(
29
+ aws_access_key_id: 'your-access-key-id',
30
+ aws_secret_access_key: 'your-secret-access-key',
31
+ bucketname: 'bucketname including PEM file',
32
+ filename: 'PEM filename'
33
+ )
34
+ ```
35
+
36
+ After that, you can send notifications normally.
37
+
38
+ ```ruby
39
+ APNS.host = 'gateway.push.apple.com' # if not sandbox
40
+ APNS.send_notification(
41
+ 'your device token'
42
+ alert: 'alert message',
43
+ badge: 1,
44
+ sound: 'default'
45
+ )
46
+
47
+ # If you want to delete PEM file
48
+ File.delete filename if File.exist? filename
49
+ ```
50
+
51
+ For `APNS` module's further information, refer
52
+ [jpoz/APNS](https://github.com/jpoz/APNS).
24
53
 
25
54
  ## Contributing
26
55
 
@@ -7,12 +7,12 @@ module ApnsS3
7
7
  #
8
8
  # @param [String] aws_access_key_id
9
9
  # @param [String] aws_secret_access_key
10
- # @param [String] bucket_name
10
+ # @param [String] bucketname
11
11
  # @param [String] filename PEM filename
12
12
  def self.set_pemfile(
13
13
  aws_access_key_id: nil,
14
14
  aws_secret_access_key: nil,
15
- bucket_name: nil,
15
+ bucketname: nil,
16
16
  filename: nil
17
17
  )
18
18
  unless File.exists? filename
@@ -20,7 +20,7 @@ module ApnsS3
20
20
  access_key_id: aws_access_key_id,
21
21
  secret_access_key: aws_secret_access_key
22
22
  )
23
- bucket = s3.buckets[bucket_name]
23
+ bucket = s3.buckets[bucketname]
24
24
  object = bucket.objects[filename]
25
25
  File.open filename, 'wb' do |file|
26
26
  object.read do |chunk|
@@ -1,3 +1,3 @@
1
1
  module ApnsS3
2
- VERSION = "0.0.1.alpha"
2
+ VERSION = "0.1.0"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: apns-s3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1.alpha
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - ka
@@ -96,9 +96,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
96
96
  version: '0'
97
97
  required_rubygems_version: !ruby/object:Gem::Requirement
98
98
  requirements:
99
- - - ">"
99
+ - - ">="
100
100
  - !ruby/object:Gem::Version
101
- version: 1.3.1
101
+ version: '0'
102
102
  requirements: []
103
103
  rubyforge_project:
104
104
  rubygems_version: 2.4.5