noteshred 1.0.1 → 1.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +14 -7
  4. data/build.rb +4 -0
  5. data/lib/noteshred/version.rb +1 -1
  6. data/noteshred.gemspec +5 -3
  7. metadata +12 -11
  8. data/build.sh +0 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ccde0fd634a9f2be578b6c9b5a903918f386e25f
4
- data.tar.gz: 5cca82b3c185dc7baeaab252be29fa5760fd7cc2
3
+ metadata.gz: ca8e5c8e3d2e606cf7552e4156d885ca7bd8adde
4
+ data.tar.gz: 975bd90ca2bc183ba2fe959898d102edc730d38a
5
5
  SHA512:
6
- metadata.gz: 320b81ee5a5792451cf5546007071f59aa11e8315b688dee7174544b03a9f879bf2710eeb96caa64505284dd1fde8b3440e4c77c6d286bfc416a3f60cef71416
7
- data.tar.gz: d8e6600fb103e32f9c3e05172b001420d62eb7b329be0f8c229dc406e84bada6381ae5eafa867820224096941683e4309e57b41042b68b63b984e5fb0b9a181b
6
+ metadata.gz: e9bb1af343d56b553cf9604674beca472da820b955c187a94b0f411b01eab98af3c21aae4f21def6bdd4c870d0eb07a2e2d7f93422e1aa33f8d2fa380dd4346e
7
+ data.tar.gz: 76408008187433111bd0563044a4630300929e1e670e232d9191eaaba4173fa7cafdad06e196a5d2a16371738a07ccfa2690d1d6013d2f813016051c9183c2a0
data/Gemfile.lock CHANGED
@@ -1,9 +1,9 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- noteshred (0.0.1)
4
+ noteshred (1.0.2)
5
5
  bcrypt (~> 3.1, >= 3.1.7)
6
- rest-client (~> 1.7, >= 1.7.2)
6
+ rest-client (~> 1.5, >= 1.5.0)
7
7
 
8
8
  GEM
9
9
  remote: https://rubygems.org/
data/README.md CHANGED
@@ -31,13 +31,13 @@ Noteshred.api_key = '6935629729ae6869c98799936591'
31
31
  Notes require a few basic properties as a minimum.
32
32
  We will create a note with the bare minimum options.
33
33
  ```ruby
34
- note = Noteshred::Note.new
34
+ note = Noteshred::Note.new
35
35
  note.title = 'Super Secret Note'
36
36
  note.content = 'Hey there, here is the info'
37
37
  note.password = 'password098'
38
38
  note.create
39
39
 
40
- #=> "{"token":"af3222afb4","title":"Super Secret Note","email":"freddy@fingers.com","email_hash":"1590fee271427e2e4fefe4faf12c835","content":"Hey there, here is the info","shred_by":"2014-12-01T21:33:50-08:00","is_shredded":false,"shred_method":1,"has_attachment":false,"created_at":"2014-11-24T21:33:50-08:00","created_by":"Freddy Fingers","hint":null,"activities":[]}"
40
+ #=> "{"token":"af3222afb4","title":"Super Secret Note","email":"freddy@fingers.com","email_hash":"1590fee271427e2e4fefe4faf12c835","shred_by":"2014-12-01T21:33:50-08:00","is_shredded":false,"shred_method":1,"has_attachment":false,"created_at":"2014-11-24T21:33:50-08:00","created_by":"Freddy Fingers","hint":null,"activities":[]}"
41
41
  ```
42
42
 
43
43
  ### Options
@@ -46,17 +46,24 @@ Title, content and password are the minimum options required for a note. This wi
46
46
  There are other options which can be set to enable various features.
47
47
 
48
48
 
49
- |Option |Type |Description|
50
- |-------|-----|-----------|
49
+ |Option |Type |Description|
50
+ |:-------:|-----|-----------|
51
51
  |hint |string|Setting a hint will add a message to any notification you sent to users regarding the note which can be used to include information about how to guess the password. The hint is set as a string. [Read More Here](https://www.noteshred.com/blog/password-hints)|
52
52
  |recipients|array|The recipients option takes an array of email addresses of which each email address will be emailed with details of how to access the note and the included hint message if set.|
53
53
 
54
+ ###Example
55
+ ```ruby
56
+ note = Noteshred::Note.new
57
+ note.recipients = ['user1@company.com','user2@company.com']
58
+ note.hint = 'The same password we use for server-x'
59
+ ```
60
+
54
61
  ## Pushing Encrypted Notes
55
62
  Pushing a note is much like creating a note except that the encryption is performed locally from the gem and the encrypted contents are simply pushed to the server to be stored.
56
63
  This is an additional measure of security for those that are concerned about wire tapping or man in the middle attacks.
57
64
 
58
65
  ```ruby
59
- note = Noteshred::Note.new
66
+ note = Noteshred::Note.new
60
67
  note.title = 'Super Secret Note'
61
68
  note.content = 'Hey there, here is the info'
62
69
  note.password = 'password098'
@@ -67,7 +74,7 @@ note.encrypt
67
74
  ```
68
75
 
69
76
  calling **.encrypt** on the note will clear any sensitive content and populate the encrypted content fields with IV and salt.
70
- To push the note to the server, simply call push on the note.
77
+ To push the note to the server, simply call **.push** on the note.
71
78
 
72
79
  ```ruby
73
80
  note.push
@@ -98,7 +105,7 @@ Requests let you receive information from someone without the need for them to h
98
105
  This person will be able to open a password protected link and enter some information to be encrypted which is then sent back to you in the form of a regular note, after which you will see it appear in your note list and can access using the password you originally defined. [Read More About Requests Here](https://www.noteshred.com/blog/information-request)
99
106
 
100
107
  ```ruby
101
- request = Noteshred::Request.new
108
+ request = Noteshred::Request.new
102
109
  request.recipient_email = 'john@company.com'
103
110
  request.password = 'xyzabc123#%'
104
111
  request.message = 'Please send me the credentials for server-x'
data/build.rb ADDED
@@ -0,0 +1,4 @@
1
+ require File.expand_path('lib/noteshred/version', File.dirname(__FILE__))
2
+ `gem build noteshred.gemspec && gem install noteshred-#{Noteshred::VERSION}.gem`
3
+ puts "Built Gem Version #{Noteshred::VERSION}"
4
+
data/lib/noteshred/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Noteshred
2
- VERSION = "1.0.1"
2
+ VERSION = "1.0.2"
3
3
  end
data/noteshred.gemspec CHANGED
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
9
9
  spec.authors = ['Cheyne Wallace']
10
10
  spec.email = ['cheyne.wallace@gmail.com']
11
11
  spec.summary = %q{Gem for interacting with the NoteShred API}
12
- spec.description = %q{Gem for interacting with the NoteShred API via HTTPS returning JSON payloads}
12
+ spec.description = %q{NoteShred is a service to send and receive encrypted, password protected notes that automatically shred after reading}
13
13
  spec.homepage = 'https://github.com/cheynewallace/noteshred-ruby'
14
14
  spec.license = 'MIT'
15
15
 
@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
22
22
  spec.add_development_dependency 'rake', '~> 10.0', '>= 10.0.0'
23
23
  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
24
24
 
25
- spec.add_dependency 'rest-client', '~> 1.7', '>= 1.7.2'
26
- spec.add_dependency 'bcrypt', '~> 3.1', '>= 3.1.7'
25
+ spec.add_dependency 'rest-client', '~> 1.5', '>= 1.5.0'
26
+ spec.add_dependency 'bcrypt', '~> 3.1', '>= 3.1.0'
27
+
28
+ spec.required_ruby_version = '>= 1.9.3'
27
29
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: noteshred
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cheyne Wallace
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-01-27 00:00:00.000000000 Z
11
+ date: 2015-01-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -70,20 +70,20 @@ dependencies:
70
70
  requirements:
71
71
  - - "~>"
72
72
  - !ruby/object:Gem::Version
73
- version: '1.7'
73
+ version: '1.5'
74
74
  - - ">="
75
75
  - !ruby/object:Gem::Version
76
- version: 1.7.2
76
+ version: 1.5.0
77
77
  type: :runtime
78
78
  prerelease: false
79
79
  version_requirements: !ruby/object:Gem::Requirement
80
80
  requirements:
81
81
  - - "~>"
82
82
  - !ruby/object:Gem::Version
83
- version: '1.7'
83
+ version: '1.5'
84
84
  - - ">="
85
85
  - !ruby/object:Gem::Version
86
- version: 1.7.2
86
+ version: 1.5.0
87
87
  - !ruby/object:Gem::Dependency
88
88
  name: bcrypt
89
89
  requirement: !ruby/object:Gem::Requirement
@@ -93,7 +93,7 @@ dependencies:
93
93
  version: '3.1'
94
94
  - - ">="
95
95
  - !ruby/object:Gem::Version
96
- version: 3.1.7
96
+ version: 3.1.0
97
97
  type: :runtime
98
98
  prerelease: false
99
99
  version_requirements: !ruby/object:Gem::Requirement
@@ -103,8 +103,9 @@ dependencies:
103
103
  version: '3.1'
104
104
  - - ">="
105
105
  - !ruby/object:Gem::Version
106
- version: 3.1.7
107
- description: Gem for interacting with the NoteShred API via HTTPS returning JSON payloads
106
+ version: 3.1.0
107
+ description: NoteShred is a service to send and receive encrypted, password protected
108
+ notes that automatically shred after reading
108
109
  email:
109
110
  - cheyne.wallace@gmail.com
110
111
  executables: []
@@ -117,7 +118,7 @@ files:
117
118
  - LICENSE.txt
118
119
  - README.md
119
120
  - Rakefile
120
- - build.sh
121
+ - build.rb
121
122
  - lib/noteshred.rb
122
123
  - lib/noteshred/api.rb
123
124
  - lib/noteshred/crypto.rb
@@ -142,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
142
143
  requirements:
143
144
  - - ">="
144
145
  - !ruby/object:Gem::Version
145
- version: '0'
146
+ version: 1.9.3
146
147
  required_rubygems_version: !ruby/object:Gem::Requirement
147
148
  requirements:
148
149
  - - ">="
data/build.sh DELETED
@@ -1 +0,0 @@
1
- gem build noteshred.gemspec && gem install noteshred-1.0.1.gem