Skip to content

Commit d94adea

Browse files
committed
* Remove .gem file from repo (it's redundant and could get out of sync with the releases).
* Fix README and EXAMPLES from referencing shiphawk-ruby to just shiphawk. * Fix copyright.
1 parent 685b5fd commit d94adea

File tree

6 files changed

+20
-15
lines changed

6 files changed

+20
-15
lines changed

EXAMPLES.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To make a connection to a ShipHawk server, create a Client connection:
66

77
```ruby
88
require 'rubygems'
9-
require 'shiphawk-ruby'
9+
require 'shiphawk'
1010

1111
# get an item based on item id
1212
client = Shiphawk::Client.new(api_token: 'api_token')
@@ -32,7 +32,7 @@ Here's an example of retrieving an Item given the Item ID using the Shiphawk::Cl
3232

3333
```ruby
3434
require 'rubygems'
35-
require 'shiphawk-ruby'
35+
require 'shiphawk'
3636

3737
# get an item based on item id
3838
client = Shiphawk::Client.new(api_token: 'api_token')
@@ -45,7 +45,7 @@ Currently undocumented on Shiphawk's api guide, so please disregard for now.
4545

4646
```ruby
4747
require 'rubygems'
48-
require 'shiphawk-ruby'
48+
require 'shiphawk'
4949

5050
# get an item based on item id
5151
client = Shiphawk::Client.new(api_token: 'api_token')
@@ -57,7 +57,7 @@ Implemented but undocumented. Not sure how this is supposed to work.
5757

5858
```ruby
5959
require 'rubygems'
60-
require 'shiphawk-ruby'
60+
require 'shiphawk'
6161

6262
# get an item based on item id
6363
client = Shiphawk::Client.new(api_token: 'api_token')
@@ -70,7 +70,7 @@ Get a shipping quote. Documentation here: https://shiphawk.com/api-docs#!/rates/
7070
Creating a quote
7171
```ruby
7272
require 'rubygems'
73-
require 'shiphawk-ruby'
73+
require 'shiphawk'
7474

7575
client = Shiphawk::Client.new(api_token: 'api_token')
7676

@@ -90,7 +90,7 @@ Create customer note about a shipment
9090

9191
```ruby
9292
require 'rubygems'
93-
require 'shiphawk-ruby'
93+
require 'shiphawk'
9494

9595
Shiphawk.notes_update(shipment_id, {body: "This is a classy note"})
9696
```
@@ -101,7 +101,7 @@ Subscribe to tracking notifications for a shipment.
101101

102102
```ruby
103103
require 'rubygems'
104-
require 'shiphawk-ruby'
104+
require 'shiphawk'
105105

106106
Shiphawk.shipments_status_update(shipment_id, {callback_url: "www.someawesomecallback.com/shipment-tracking-callback/#{shipment_id}"})
107107
```
@@ -112,7 +112,7 @@ Create a shipment
112112

113113
```ruby
114114
require 'rubygems'
115-
require 'shiphawk-ruby'
115+
require 'shiphawk'
116116

117117
data = {
118118
xid: buyer_invoice.to_s,
@@ -140,7 +140,7 @@ Update a number of shipments at once (need to confirm)
140140

141141
```ruby
142142
require 'rubygems'
143-
require 'shiphawk-ruby'
143+
require 'shiphawk'
144144
Shiphawk.shipments_status_update({shipment_ids: [1,2,3], status: "in_transit"})
145145
```
146146

@@ -150,6 +150,6 @@ Get all zip codes using pagination.
150150

151151
```ruby
152152
require 'rubygems'
153-
require 'shiphawk-ruby'
153+
require 'shiphawk'
154154
Shiphawk.zip_codes_index
155155
```

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2015 Robert Schmitt
1+
Copyright (c) 2015 Hawk Applications Corp.
22

33
MIT License
44

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Ruby wrapper for the ShipHawk V3 API. The ShipHawk::Client gem provides an easy-
77
Add this line to your application's Gemfile:
88

99
```ruby
10-
gem 'shiphawk-ruby'
10+
gem 'shiphawk'
1111
```
1212

1313
And then execute:
@@ -16,7 +16,7 @@ And then execute:
1616

1717
Or install it yourself as:
1818

19-
$ gem install shiphawk-ruby
19+
$ gem install shiphawk
2020

2121
## Usage
2222

@@ -39,4 +39,4 @@ When an *error status* is received from the server, the gem will raise an error
3939

4040
## Copyright
4141

42-
Copyright (c) 2015 HAWK Applications Inc., [Robert Schmitt]([email protected]). See LICENSE for details.
42+
Copyright (c) 2015 Hawk Applications Corp. See LICENSE for details.

history.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
=== 0.8.1 2015-11-03
2+
3+
* Remove .gem file from repo (it's redundant and could get out of sync with the releases).
4+
* Fix README and EXAMPLES from referencing shiphawk-ruby to just shiphawk.
5+
* Fix copyright.

lib/shiphawk/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module Shiphawk
22
module VERSION #:nodoc:
33
MAJOR = 0
44
MINOR = 8
5-
PATCH = 0
5+
PATCH = 1
66
PRE = nil
77
STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
88
end

shiphawk-0.8.0.gem

-10 KB
Binary file not shown.

0 commit comments

Comments
 (0)