wix-hive-ruby 0.9.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9c0a428e9d239062e4bed3ecd09e30c80d5e221
-  data.tar.gz: 7456a654728360f4c7ecc7d265aab7c862beced0
+  metadata.gz: dcaac76a82c3515274db30612aef088800c4e1ea
+  data.tar.gz: 7b877ce543e8a2c5b83d012b98f30d61c2bfef9f
 SHA512:
-  metadata.gz: 17922239717fc4db75d6c06a2190491e5a3ab903abd80d4bfca7ecccaf8ec9478c2d6fabdc7e53f070a5d29a926214a5914524a0935d599bc97154611491ce07
-  data.tar.gz: fef830329b8e23d4284a3af80adc5c6822a5c70cb535ae708bfdca4ef38464d60cac0849f6c2a3fc27721c8d87aefd10ad91e8cd5916e0751274c08e749a75ee
+  metadata.gz: 5f09738bb2d9404c63299530dc8a4c6d2f2799decd12a220e58171957da5e0d0d80a54958063a38bd254e241ea242efaaefa517201898de2d5ed56889da8d407
+  data.tar.gz: 2da22c5af6291f5076d836297c82c070230a4b1bd2744ce600829fa7111b1dfbfe3a922bb9a429c2631a17823be6fe5a012919a3c006d1023a18df00462857d1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 David Zuckerman
+Copyright (c) 2014 Wix.com, Inc
 
 MIT License
 

data/README.md

@@ -54,13 +54,18 @@ A Ruby interface to the Wix Hive API.
    * **[Insights API](#insights-api)**
      * **[client.activities_summary](#clientactivities_summary)**
      * **[client.contact_activities_summary](#clientcontact_activities_summary)**
+   * **[Sites API](#sites-api)**
+     * **[client.sites_site](#clientsites_site)**
+     * **[client.sites_site_pages](#clientsites_site_pages)**
+   * **[Redirects API](#insights-api)**
+     * **[client.redirects](#clientredirects)**
 5. **[Contributing](#contributing)**
    * **[Submitting an Issue](#submitting-an-issue)**
    * **[Submitting a Pull Request](#submitting-a-pull-request)**
 
 ## Prerequisites
-- **Read about** [developing a third party app for the Wix platform](http://dev.wix.com/docs/display/DRAF/Third+Party+Apps+-+Introduction).
-- **Register your app** [here](http://dev.wix.com/docs/display/DRAF/Dev+Center+Registration+Guide) to **obtain** your **APP_KEY** and **APP_SECRET**
+- **Read about** [developing a third party app for the Wix platform](http://dev.wix.com/docs/getting-started).
+- **Register your app** [here](http://dev.wix.com/docs/publish/registration) to **obtain** your **APP_KEY** and **APP_SECRET**
 
 ## Installation
 
@@ -143,8 +148,8 @@ Hive::Client.new do |config|
 end
 ```
 
-1. The `config.secret_key` and `config.app_id` are obtained by registering an app as it is outlined [here](http://dev.wix.com/docs/display/DRAF/Dev+Center+Registration+Guide)
-2. The `config.instance_id` is obtained by decoding the signed app instance. Learn more about this  [here](http://dev.wix.com/docs/display/DRAF/Using+the+Signed+App+Instance)
+1. The `config.secret_key` and `config.app_id` are obtained by registering an app as it is outlined [here](http://dev.wix.com/docs/publish/registration)
+2. The `config.instance_id` is obtained by decoding the signed app instance. Learn more about this  [here](http://dev.wix.com/docs/infrastructure/app-instance#overview)
    * Note: The Hive client has a utility method that parses the instance data. Example usage:
    ``` ruby
    wixInstance = Hive::Client.parse_instance_data(INSTANCE, SECRET-KEY)
@@ -349,10 +354,11 @@ contact = Hive::Contact.new
 ```
   
 #### client.contact
+Get a Contact by ID
 
 **Example:**
 ``` ruby
-client.contact(CONTACT_ID)
+contact = client.contact(CONTACT_ID)
 ```
 
 #### client.update_contact (PENDING)
@@ -563,11 +569,6 @@ client.contact_activities(CONTACT_ID)
 ``` ruby
 client.contacts
 client.contacts( pageSize: 50 )
-client.contacts( tag: 'contacts_server/new' )
-client.contacts( email: 'alex@example.com' )
-client.contacts( phone: '123456789' )
-client.contacts( firstName: 'E2E' )
-client.contacts( lastName:'Cool' )
 ```
 
 #### client.upsert_contact
@@ -626,7 +627,33 @@ client.upsert_contact( phone: '123456789', email: 'alex@example.com' )
 **Example:**
    ``` ruby
    client.contact_activities_summary(CONTACT_ID)
+   ```   
+
+### Sites API
+
+#### client.sites_site
+
+**Example:**
+   ``` ruby
+   client.sites_site
    ```
+   
+#### client.sites_site_pages
+
+**Example:**
+   ``` ruby
+   client.sites_site_pages
+   ```
+   
+### Redirects API
+
+#### client.redirects
+
+**Example:**
+   ``` ruby
+   client.redirects
+   ```
+
 ## Contributing
 
 **Everyone** is encouraged to help **improve** this gem. Some of the ways you can contribute include:
@@ -639,7 +666,7 @@ client.upsert_contact( phone: '123456789', email: 'alex@example.com' )
 6. Write code (**no patch is too small**: fix typos, clean up inconsistent whitespace).
 7. Refactor code.
 8. Fix [issues](https://github.com/wix/wix-hive-ruby/issues).
-9. Submitt an Issue
+9. Submit an Issue
 
 ### Submitting an Issue
 

data/e2e/activities_api_spec.rb

@@ -62,20 +62,44 @@ describe 'Activities API' do
   context 'create activities' do
     it 'CONTACT_CONTACT_FORM' do
 
-      contacts_create = FACTORY::CONTACT_CONTACT_FORM.klass.new
-      contacts_create.add_field(name: 'name', value: 'value')
+      contact_form = FACTORY::CONTACT_CONTACT_FORM.klass.new
+      contact_form.add_field(name: 'name', value: 'value')
 
       activity = Hive::Activity.new(
           type: FACTORY::CONTACT_CONTACT_FORM.type,
           locationUrl: 'http://www.wix.com',
           details: {summary: 'test', additionalInfoUrl: 'http://www.wix.com'},
-          info: contacts_create)
+          info: contact_form)
 
       new_activity_result = client.new_activity(session_id, activity)
 
       expect(new_activity_result.activityId).to be_truthy
     end
 
+    it 'CONTACT_SUBSCRIPTION_FORM' do
+
+      email = 'karen@meep.com'
+      phone = '+1-555-555-555'
+      name = {prefix: 'sir', first: 'mix', middle: 'a lot', last: 'the', suffix: 'III'}
+
+      sub_form = FACTORY::CONTACT_SUBSCRIPTION_FORM.klass.new(email: email,
+                                                        phone: phone,
+                                                        name: name)
+      
+      sub_form.add_field(name: 'name', value: 'value')
+      activity = Hive::Activity.new(
+          type: FACTORY::CONTACT_SUBSCRIPTION_FORM.type,
+          locationUrl: 'http://www.wix.com',
+          details: {summary: 'test', additionalInfoUrl: 'http://www.wix.com'},
+          info: sub_form
+          )
+
+      
+      new_activity_result = client.new_activity(session_id, activity)
+
+      expect(new_activity_result.activityId).to be_truthy
+    end
+
     it 'CONVERSION_COMPLETE' do
       activity = Hive::Activity.new(
           type: FACTORY::CONVERSION_COMPLETE.type,
@@ -356,5 +380,75 @@ describe 'Activities API' do
 
       expect(new_activity_result.activityId).to be_truthy
     end
+
+    it 'SHIPPING_DELIVERED' do
+      item = {id: 1, sku: 'sky', title: 'title', quantity: 1, price: '1', formattedPrice: '1.1', currency: 'EUR', productLink: 'link'}
+
+      delivered = FACTORY::SHIPPING_DELIVERED.klass.new(orderId: '11111',
+                                                        items: [item],
+                                                        shippingDetails: {tracking: '123456'},
+                                                        note: 'Note')
+
+      activity = Hive::Activity.new(
+          type: FACTORY::SHIPPING_DELIVERED.type,
+          locationUrl: 'http://www.wix.com',
+          details: {summary: 'test', additionalInfoUrl: 'http://www.wix.com'},
+          info: delivered)
+
+      new_activity_result = client.new_activity(session_id, activity)
+
+      expect(new_activity_result.activityId).to be_truthy
+    end
+
+    it 'SHIPPING_SHIPPED' do
+      shipping_address = {firstName: 'Wix' , lastName: 'Cool', email: 'wix@example.com', phone: '12345566', country: 'Macedonia', countryCode: 'MK', region: 'Bitola', regionCode: '7000', city: 'Bitola', address1: 'Marshal Tito', address2: 'Marshal Tito', zip: '7000', company: 'Wix.com'}
+      day_ago = (Time.now - (60 * 60 * 24)).iso8601(3)
+      delivery_estimate = { start: day_ago, end: Time.now.iso8601(3) }
+
+      shipping_details = {method: 'USPS', tracking: '123456', deliveryEstimate: delivery_estimate}
+      item = {id: 1, sku: 'sky', title: 'title', quantity: 1, price: '1', formattedPrice: '1.1', currency: 'EUR', productLink: 'link'}
+
+      delivered = FACTORY::SHIPPING_SHIPPED.klass.new(orderId: '11111',
+                                                        items: [item],
+                                                        shippingDetails: shipping_details,
+                                                        shippingAddress: shipping_address,
+                                                        note: 'Note')
+
+      activity = Hive::Activity.new(
+          type: FACTORY::SHIPPING_SHIPPED.type,
+          locationUrl: 'http://www.wix.com',
+          details: {summary: 'test', additionalInfoUrl: 'http://www.wix.com'},
+          info: delivered)
+
+      new_activity_result = client.new_activity(session_id, activity)
+
+      expect(new_activity_result.activityId).to be_truthy
+    end
+
+    it 'SHIPPING_STATUS_CHANGED' do
+      shipping_address = {firstName: 'Wix' , lastName: 'Cool', email: 'wix@example.com', phone: '12345566', country: 'Macedonia', countryCode: 'MK', region: 'Bitola', regionCode: '7000', city: 'Bitola', address1: 'Marshal Tito', address2: 'Marshal Tito', zip: '7000', company: 'Wix.com'}
+      day_ago = (Time.now - (60 * 60 * 24)).iso8601(3)
+      delivery_estimate = { start: day_ago, end: Time.now.iso8601(3) }
+
+      shipping_details = {method: 'USPS', tracking: '123456', deliveryEstimate: delivery_estimate}
+      item = {id: 1, sku: 'sky', title: 'title', quantity: 1, price: '1', formattedPrice: '1.1', currency: 'EUR', productLink: 'link'}
+
+      delivered = FACTORY::SHIPPING_STATUS_CHANGED.klass.new(orderId: '11111',
+                                                      status: 'AWAITING_FULFILMENT',
+                                                      items: [item],
+                                                      shippingDetails: shipping_details,
+                                                      shippingAddress: shipping_address,
+                                                      note: 'Note')
+
+      activity = Hive::Activity.new(
+          type: FACTORY::SHIPPING_STATUS_CHANGED.type,
+          locationUrl: 'http://www.wix.com',
+          details: {summary: 'test', additionalInfoUrl: 'http://www.wix.com'},
+          info: delivered)
+
+      new_activity_result = client.new_activity(session_id, activity)
+
+      expect(new_activity_result.activityId).to be_truthy
+    end
   end
 end

data/e2e/contacts_api_spec.rb

@@ -53,29 +53,10 @@ describe 'Contacts API' do
       expect(client.contacts( pageSize: 50 ).results.size).to eq 50
     end
 
-    it 'should be able to query by tag' do
-      expect(client.contacts( tag: 'contacts_server/new' ).results.size).to be > 0
-    end
-
-    it 'should be able to query by email' do
-      expect(client.contacts( email: 'alext@wix.com' ).results.size).to be > 0
-    end
-
-    it 'should be able to query by phone' do
-      expect(client.contacts( phone: '123456789' ).results.size).to be > 0
-    end
-
-    it 'should be able to query by firstName' do
-      expect(client.contacts( firstName: 'E2E' ).results.size).to be > 0
-    end
-
-    it 'should be able to query by lastName' do
-      expect(client.contacts( lastName:'Cool' ).results.size).to be > 0
-    end
   end
 
   it '.update_contact' do
-    pending('HIVE-3')
+    pending('HAPI-3')
     contact = Hive::Contact.new
     contact.name.first = 'E2E'
     contact.name.last = 'Cool'
@@ -105,20 +86,85 @@ describe 'Contacts API' do
   end
 
   context '.upsert_contact' do
-    it 'should upsert a contact given a phone' do
-      expect(client.upsert_contact(phone: rand(10**10))).to include :contactId
+    it 'should return an existing Contact given its phone' do
+      contact = create_base_contact_and_return
+
+      phone = rand(10**10)
+      updated_phone = Hive::Phone.new
+      updated_phone.tag = 'test'
+      updated_phone.phone = phone
+
+      client.update_contact_phone(contact.id, contact.phones.first.id, updated_phone, contact.modifiedAt)
+
+      upsert_result = client.upsert_contact(phone: phone)
+
+      expect(upsert_result).to include :contactId
+      expect(upsert_result.contactId).to eq contact.id
     end
 
-    it 'should upsert a contact given a email' do
-      expect(client.upsert_contact(email: rand(36**10).to_s(36))).to include :contactId
+    it 'should return an existing Contact given its email' do
+      contact = create_base_contact_and_return
+
+      email = rand(36**10).to_s(36)
+      updated_email = Hive::Email.new
+      updated_email.tag = 'work'
+      updated_email.email = email
+      updated_email.emailStatus = 'optOut'
+
+      client.update_contact_email(contact.id, contact.emails.first.id, updated_email, contact.modifiedAt)
+
+      upsert_result = client.upsert_contact(email: email)
+
+      expect(upsert_result).to include :contactId
+      expect(upsert_result.contactId).to eq contact.id
     end
 
-    it 'should upsert a contact given a email and phone' do
-      expect(client.upsert_contact(phone: rand(10**10), email: rand(36**10).to_s(36))).to include :contactId
+    it 'should return the same Contact every time given same phone and userSessionToken' do
+
+      contact_phone_for_session = USER_SESSION_PHONE
+      token = USER_SESSION_TOKEN
+      upsert1_result = client.upsert_contact(phone: contact_phone_for_session, userSessionToken: token)
+      expect(upsert1_result).to include :contactId
+
+      upsert2_result = client.upsert_contact(phone: contact_phone_for_session, userSessionToken: token)
+      expect(upsert2_result).to include :contactId
+      expect(upsert2_result.contact_id).to eq upsert1_result.contact_id
+    end
+
+    it 'should return the same Contact every time given same email and userSessionToken' do
+
+      contact_email_for_session = USER_SESSION_EMAIL
+      token = USER_SESSION_TOKEN
+      upsert1_result = client.upsert_contact(email: contact_email_for_session, userSessionToken: token)
+      expect(upsert1_result).to include :contactId
+
+      upsert2_result = client.upsert_contact(email: contact_email_for_session, userSessionToken: token)
+      expect(upsert2_result).to include :contactId
+      expect(upsert2_result.contact_id).to eq upsert1_result.contact_id
     end
 
-    it 'should return a contact given a exiting phone' do
-      expect(client.upsert_contact(phone: '123456789', email: 'alext@wix.com')).to include :contactId
+    it 'should return an existing Contact given its email and phone' do
+      contact = create_base_contact_and_return
+
+      phone = rand(10**10)
+      updated_phone = Hive::Phone.new
+      updated_phone.tag = 'test'
+      updated_phone.phone = phone
+
+      client.update_contact_phone(contact.id, contact.phones.first.id, updated_phone, contact.modifiedAt)
+
+      email = rand(36**10).to_s(36)
+      updated_email = Hive::Email.new
+      updated_email.tag = 'work'
+      updated_email.email = email
+      updated_email.emailStatus = 'optOut'
+
+      client.update_contact_email(contact.id, contact.emails.first.id, updated_email, contact.modifiedAt)
+
+      upsert_result = client.upsert_contact(phone: phone, email: email)
+
+      expect(upsert_result).to include :contactId
+      expect(upsert_result.contactId).to eq contact.id
     end
   end
 

data/e2e/e2e_helper.rb

@@ -3,6 +3,9 @@ require 'time'
 require 'vcr'
 
 RECORD_MODE =  ENV['ACCEPTANCE']  ? :all : :new_episodes
+USER_SESSION_EMAIL = 'USER_SESSION_EMAIL'
+USER_SESSION_PHONE = 'USER_SESSION_PHONE'
+USER_SESSION_TOKEN = 'USER_SESSION_TOKEN'
 
 VCR.configure do |c|
   c.cassette_library_dir = 'e2e/fixtures/vcr_cassettes'
@@ -24,8 +27,9 @@ end
 
 def client
   Hive::Client.new do |config|
-    config.secret_key = 'YOUR_SECRET_KEY'
-    config.app_id = 'YOUR_APP_ID'
-    config.instance_id = 'YOUR_INSTANCE_ID'
+    config.secret_key = 'ffedea93-cd67-44d9-9784-f1ca39a001e9'
+    config.app_id = '13950910-451e-3d31-14ef-9e2901a24f8a'
+    config.instance_id = '13950958-34f4-65d3-1c4c-08cdf91b45a2'
+    #config.api_base = 'http://apu1.aus.wixpress.com:25780/app-integration-bus-web/backend'
   end
 end

data/e2e/redirects_api_spec.rb

@@ -0,0 +1,7 @@
+require_relative './e2e_helper'
+
+describe 'Redirects API' do
+  it '.redirects' do
+    expect(client.redirects).to be_a Hive::Redirects
+  end
+end

data/e2e/sites_api_spec.rb

@@ -0,0 +1,11 @@
+require_relative './e2e_helper'
+
+describe 'Sites API' do
+  it '.sites_site' do
+    expect(client.sites_site).to be_a Hive::Site
+  end
+  
+  it '.sites_site_pages' do
+    expect(client.sites_site_pages).to be_a Hive::SitePages
+  end
+end

data/lib/hive/activities/contact/contact_create_activity.rb

@@ -1,5 +1,5 @@
 # THIS IS A GENERATED FILE, DO NOT EDIT THIS
-# Generated on 2014-10-01T07:31:22.131Z
+# Generated on 2015-02-19T18:01:11.081Z
 
 require 'hashie'
 require 'hive/extensions/hashie_validate_enum'
@@ -7,16 +7,6 @@ require 'hive/extensions/hashie_validate_enum'
 module Hive
   module Activities
     module Contact
-      class Name < Hashie::Trash
-        include Hashie::Extensions::IgnoreUndeclared
-
-        property :prefix
-        property :first
-        property :middle
-        property :last
-        property :suffix
-      end
-
       class Company < Hashie::Trash
         include Hashie::Extensions::IgnoreUndeclared
 

data/lib/hive/activities/contact/contact_form_activity.rb

@@ -1,5 +1,5 @@
 # THIS IS A GENERATED FILE, DO NOT EDIT THIS
-# Generated on 2014-10-01T07:31:22.097Z
+# Generated on 2015-02-19T18:01:10.985Z
 
 require 'hashie'
 require 'hive/extensions/hashie_validate_enum'
@@ -14,7 +14,7 @@ module Hive
         property :value, required: true
       end
 
-      class FormActivity < Hashie::Trash
+      class ContactFormActivity < Hashie::Trash
         include Hashie::Extensions::IgnoreUndeclared
         include Hashie::Extensions::Coercion