passworks 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a01901fb5bd0f809db6d23577640f39308d893aa
-  data.tar.gz: 8f423a398e1b7bd502076cc20b9376ae7f5975a2
+  metadata.gz: 4d7e2ee6c6e59b1cf631ac126267597f58b56cf2
+  data.tar.gz: e2630db18d08ea6abbb0c24a303f52b601bf404a
 SHA512:
-  metadata.gz: 03057761c29430d3599053ef6fd96d69a6229f2b57e0c3280bfe8384b287a4a38717058482181e4da97ddf7994c3f59f16a8803d7fd6ca8d46002a505d65870f
-  data.tar.gz: 734df083da0e114e9f36fc78b5910bfa390b42fb29b2f4594e7c578c23d4794970ed2fb5aa01216d52d4f254a900af944b786c2f6dfd450eb1833718b23baaa3
+  metadata.gz: a1db6971e9502f7197a81f6ab04aabbd71e82a0fa6fe79fc1b897d21e0ceb15592b2290f571704e5bbf8c6de4493b4b0bc9bf230e6cf2bbefeec37301b69940e
+  data.tar.gz: 8e0c103e7bc590ef274ef4b0b2c56c653e98a74f2fb13e0caff38b9074c303b1fb2b3d009b86b8154f96ef074bf49cdfe93d9c0af7483e644c7e3c50f24d307b

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 This file is a manually maintained list of changes for each release. Feel free to add your
 changes here when sending pull requests. Also send corrections if you spot any mistakes.
 
+## v2.0.3 (2015-12-09)
+* Added campaign resource's merge call, for propagating campaign pass data changes
+  to all of it's passes.
+
 ## v2.0.2 (2015-12-01)
 * Fixing collection_uuid on PassResource
 

data/README.md

@@ -40,8 +40,8 @@ client = Passworks.new
 ```ruby
 # Instance level configuration
 client = Passworks.new({
-	api_username: 'your api username',
-	api_secret: 'your api secret'
+  api_username: 'your api username',
+  api_secret: 'your api secret'
 })
 ```
 
@@ -49,6 +49,10 @@ client = Passworks.new({
 
 ### Certificates
 
+Certificates are an essential part of every campaign.
+
+They're used to uniquely identify a certain person or organization, and offer authenthicity reasurance. [See Passworks API](https://github.com/passworks/passworks-api/blob/master/v2/sections/certificates.md#certificates) for mode information.
+
 ```ruby
 # Fetch and iterate through all your certificates
 certificates = client.certificates.all
@@ -62,6 +66,10 @@ certificate = client.certificates.find('c3d5fc64-3a43-4d3a-a167-473dfeb1edd3')
 
 ### Assets
 
+Assets are the visual elements of the pass.
+
+You can reuse assets, meaning that you can assign the same asset to multiple passes, reducing the number of asset operations and also reducing the amount of bandwidth required to create a pass. [See Passworks API](https://github.com/passworks/passworks-api/blob/master/v2/sections/assets.md#assets) for mode information.
+
 ```ruby
 # Upload an asset (icon image)
 asset_icon = client.assets.create({ file: '/path-to-file/icon-file.png', asset_type: 'icon' })
@@ -84,6 +92,8 @@ asset.delete
 
 ### Coupons
 
+Coupons can be used to offer customers a discount or promotion, or as a general proximity marketing asset. [See Passworks API](https://github.com/passworks/passworks-api/blob/master/v2/sections/coupon.md) for mode information.
+
 ```ruby
 # Create a coupon campaign
 coupon_campaign = client.coupons.create({
@@ -131,6 +141,9 @@ updated_coupon_pass = coupon_pass.update({
 
 ### Store Cards
 
+The Passworks API can be used to create loyalty or event tier programs to reward your customers for using your services. [See Passworks API](https://github.com/passworks/passworks-api/blob/master/v2/sections/store_card.md) for mode information.
+
+
 ```ruby
 # Create a store card campaign
 coupon_campaign = client.store_cards.create({
@@ -178,6 +191,8 @@ updated_coupon_pass = store_card_pass.update({
 
 ### Event Tickets
 
+Event Tickets are passes used for events such as concerts, movie tickets, galas, meetings or other types of activity that happen in a specific time or day. [See Passworks API](https://github.com/passworks/passworks-api/blob/master/v2/sections/event_ticket.md) for mode information.
+
 ```ruby
 # Create a event ticket campaign
 event_ticket_campaign = client.event_tickets.create({
@@ -225,6 +240,9 @@ updated_event_ticket_pass = event_ticket_pass.update({
 
 ### Bording Passes
 
+Boarding passes can be airplane, bus, train, or boat tickets. You also can create generic boarding passes. [See Passworks API](https://github.com/passworks/passworks-api/blob/master/v2/sections/boarding_pass.md) for mode information.
+
+
 ```ruby
 # Create a boarding pass campaign
 boarding_pass_campaign = client.boarding_passes.create({
@@ -273,6 +291,8 @@ updated_boarding_pass_pass = boarding_pass_pass.update({
 
 ### Generic
 
+Generic passes can be used for anything that doesn't fit in the other pass categories. [See Passworks API](https://github.com/passworks/passworks-api/blob/master/v2/sections/generic.md) for mode information.
+
 ```ruby
 # Create a generic pass campaign
 generic_campaign = client.boarding_passes.create({
@@ -318,6 +338,53 @@ updated_generic_pass = generic_pass.update({
 })
 ```
 
+## Updating campaign passes in a single request
+
+It's possible to update the passes presentation fields (`primary_fields`, `secondary_fields`, `auxiliary_fields` and `back_fields`) using the Campaign data in a single request.
+
+For that you only need to follow the 2 steps:
+
+1. Update the campaign with the intended information.
+2. Call the `merge` method in the campaign, this method merges the presentation fields of the campaign with the passes information.
+
+```ruby
+	# Find the campaign that you wish to update
+	campaign = client.coupons.find("c3d5fc64-3a43-4d3a-a167-473dfeb1edd3")
+	
+	# Update the campaign
+	campaign.update({
+		secondary_fields: [
+			{
+				key: "date",
+				label: "Promotion expires at",
+				value: "31/12/2015"
+			}
+		]
+	})
+	
+	# Update the campaign passes
+	campaign.merge
+```
+
+
+> IMPORTANTE: This method updates all passes `beacons` and `locations` (geo locations) with the Campaign defined ones, overriding the existing in the passes.
+
+
+## Understanding behaviour fields (fixed vs dynamic content)
+
+The presentation fields (`primary_fields`, `secondary_fields`, `auxiliary_fields` and `back_fields`) have a new (`behaviour`) attribute. This attribute can have one of two values: `fixed` or `dynamic` _(by default the `behaviour` is set to `fixed`)_.
+
+- fixed
+
+	`fixed` means that the value is `static`: every pass will have the same `label` and `value` for this field.
+	So when you call the  `merge` method in the Ruby client this field will be added or overriden (if the field with the same `key` exists) in every pass even if you had previously customized the value per pass. Don't use the type of field for custom fields in your passes eg: __name__, __client id__, __ticket number__ ,etc. This type of _behaviour_ is a good fit for fields that are the same across all passes eg: `event date`, `event location`, `flight number`, etc.
+
+- dynamic
+
+	The `dynamic` _behaviour_ defines the field as a custom updated field that shouldn't be updated on a bulk update when the `merge` method is called.
+	This field will only be updated when the user updates that field specifically for that pass. This type of _behaviour_ is a good fit for custom fields like `ticket number`, `user name`, `boarding number`, `seat number`, etc..
+	
+
 ## Documentation
 
 For more information about the API please please refere to [https://github.com/passworks/passworks-api](https://github.com/passworks/passworks-api)

data/lib/passworks/campaign_resource.rb

@@ -23,6 +23,13 @@ module Passworks
       client.post("#{collection_name}/#{id}/push").ok?
     end
 
+    # Merges all campaign data changes into the passes using the PassUpdater
+    # /lib/ in the main backend-saas project.
+    # @return [Boolean]
+    def merge
+      client.post("#{collection_name}/#{id}/merge").ok?
+    end
+
     # Updates the {CampaignResource} and returns the updated instance
     # @return [CampaignResource] Updated instance
     def update(data, params={})

data/lib/passworks/version.rb

@@ -1,3 +1,3 @@
 module Passworks
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passworks
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Luis Mendes
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -240,3 +240,4 @@ test_files:
 - spec/support/.DS_Store
 - spec/support/assets/logo.png
 - spec/support/vcr_setup.rb
+has_rdoc: