cashstar 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. data/.DS_Store +0 -0
  2. data/README.md +42 -0
  3. data/lib/cashstar/client/merchants.rb +2 -1
  4. data/lib/cashstar/version.rb +1 -1
  5. metadata +13 -11
data/.DS_Store ADDED
Binary file
data/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # A CashStar Ruby Gem
2
+ A Ruby wrapper for the CashStar REST API
3
+
4
+ ## <a name="installation">Installation</a>
5
+ gem install cashstar
6
+
7
+ ## <a name="Full API Docs">Full Documentation</a>
8
+ please consult your CashStar API documentation for full use cases and support
9
+
10
+ ## <a name="Notes">Current Limitations</a>
11
+ as of v0.1.2, this gems supports json only and only one gift card is supported per order.
12
+
13
+ ## <a name="examples">Usage Examples</a>
14
+ require "cashstar"
15
+
16
+ # Configure your CashStar settings - for Rails, typically in /config/initializers/cashstar.rb
17
+ # Optionally, store your credentials for each environment in a cashstar.yml file and load from there.
18
+
19
+ Cashstar.configure do |config|
20
+ config.username = 'username'
21
+ config.password = 'password'
22
+ config.endpoint = 'production or semi-production url'
23
+ config.format = 'json' #or 'xml'
24
+ end
25
+
26
+ # Get all merchants enabled for this account
27
+ puts Cashstar.merchants
28
+
29
+ # Get all faceplates for a merchant
30
+ puts Cashstar.faceplates(:merchant_code)
31
+
32
+ # Build an Order Entity
33
+ # An order is composed of one or many gift card entities, which are in turn composed of delivery and message entities
34
+ delivery = Cashstar::Client::Delivery.new(:delivered_by => :CLIENT)
35
+ message = Cashstar::Client::Message.new(:body => 'Thanks for all the hard work!', :from => 'Santa Claus', :to => 'Rudolph')
36
+ gift_card = Cashstar::Client::GiftCard.new(:merchant_code => 'GAP', :initial_balance => '100.00', :delivery => delivery, :message => message)
37
+ order = Cashstar::Client::Order.new(:audit_number => '123456', :gift_card => gift_card) #Audit Number is required
38
+
39
+
40
+ # Issue the built order
41
+ puts Cashstar.issue(order)
42
+
data/lib/cashstar/client/merchants.rb CHANGED
@@ -6,7 +6,8 @@ module Cashstar
6
6
 
7
7
  def merchants
8
8
  response = get("/v2/merchant/")
9
- format.to_s.downcase == 'xml' ? response['merchant'] : response['merchants']['merchant']
9
+ puts response
10
+ #format.to_s.downcase == 'xml' ? response['merchant'] : response['merchants']['merchant']
10
11
  end
11
12
 
12
13
 
data/lib/cashstar/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Cashstar
2
- VERSION = "0.1.1"
2
+ VERSION = "0.1.2"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cashstar
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -13,7 +13,7 @@ date: 2011-10-06 00:00:00.000000000Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: hashie
16
- requirement: &70194283142400 !ruby/object:Gem::Requirement
16
+ requirement: &70158028059060 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ~>
@@ -21,10 +21,10 @@ dependencies:
21
21
  version: 1.1.0
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *70194283142400
24
+ version_requirements: *70158028059060
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: faraday
27
- requirement: &70194283141780 !ruby/object:Gem::Requirement
27
+ requirement: &70158028058320 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ~>
@@ -32,10 +32,10 @@ dependencies:
32
32
  version: 0.7.4
33
33
  type: :runtime
34
34
  prerelease: false
35
- version_requirements: *70194283141780
35
+ version_requirements: *70158028058320
36
36
  - !ruby/object:Gem::Dependency
37
37
  name: faraday_middleware
38
- requirement: &70194283141160 !ruby/object:Gem::Requirement
38
+ requirement: &70158028057800 !ruby/object:Gem::Requirement
39
39
  none: false
40
40
  requirements:
41
41
  - - ~>
@@ -43,10 +43,10 @@ dependencies:
43
43
  version: 0.7.0
44
44
  type: :runtime
45
45
  prerelease: false
46
- version_requirements: *70194283141160
46
+ version_requirements: *70158028057800
47
47
  - !ruby/object:Gem::Dependency
48
48
  name: multi_json
49
- requirement: &70194283140540 !ruby/object:Gem::Requirement
49
+ requirement: &70158028057160 !ruby/object:Gem::Requirement
50
50
  none: false
51
51
  requirements:
52
52
  - - ~>
@@ -54,10 +54,10 @@ dependencies:
54
54
  version: 1.0.0
55
55
  type: :runtime
56
56
  prerelease: false
57
- version_requirements: *70194283140540
57
+ version_requirements: *70158028057160
58
58
  - !ruby/object:Gem::Dependency
59
59
  name: multi_xml
60
- requirement: &70194283140000 !ruby/object:Gem::Requirement
60
+ requirement: &70158028056480 !ruby/object:Gem::Requirement
61
61
  none: false
62
62
  requirements:
63
63
  - - ~>
@@ -65,7 +65,7 @@ dependencies:
65
65
  version: 0.4.0
66
66
  type: :runtime
67
67
  prerelease: false
68
- version_requirements: *70194283140000
68
+ version_requirements: *70158028056480
69
69
  description: CashStar's API provides a simple interface for purchasing and issuing
70
70
  electronic gift cards from a variety of brands
71
71
  email:
@@ -74,8 +74,10 @@ executables: []
74
74
  extensions: []
75
75
  extra_rdoc_files: []
76
76
  files:
77
+ - .DS_Store
77
78
  - .gitignore
78
79
  - Gemfile
80
+ - README.md
79
81
  - Rakefile
80
82
  - cashstar.gemspec
81
83
  - lib/.DS_Store