wix-hive-ruby 0.9.0

data/lib/hive/rest/api.rb

@@ -0,0 +1,13 @@
+require 'hive/rest/contacts'
+require 'hive/rest/activities'
+require 'hive/rest/insights'
+
+module Hive
+  module REST
+    module API
+      include Hive::REST::Contacts
+      include Hive::REST::Activities
+      include Hive::REST::Insights
+    end
+  end
+end

data/lib/hive/rest/contacts.rb

@@ -0,0 +1,114 @@
+require 'hive/contact'
+require 'hive/util'
+require 'time'
+require 'hive/activities/factory'
+
+module Hive
+  module REST
+    module Contacts
+      include Hive::Util
+
+      def contacts(query_options = {})
+        perform_with_cursor(:get, 'v1/contacts', Hive::Contact, params: query_options)
+      end
+
+      def contact(contact_id)
+        perform_with_object(:get, "v1/contacts/#{contact_id}", Hive::Contact)
+      end
+
+      def new_contact(contact)
+        perform_with_object(:post, 'v1/contacts', Hashie::Mash, body: contact.to_json)
+      end
+
+      def upsert_contact(args)
+        fail ArgumentError, 'Phone or Email are required!' unless args.key?(:phone) || args.key?(:email)
+
+        perform_with_object(:put, 'v1/contacts', Hashie::Mash, body: args.to_json)
+      end
+
+      def contacts_tags
+        perform_with_object(:get, 'v1/contacts/tags', Array)
+      end
+
+      def contacts_subscribers
+        perform_with_cursor(:get, 'v1/contacts/subscribers', Hive::ContactSubscriber)
+      end
+
+      def update_contact(_contact_id, _contact)
+        fail NotImplementedError, 'Update contacts is not available!'
+
+        # edit_contact_field("v1/contacts/#{contact_id}", contact)
+      end
+
+      def update_contact_name(id, name)
+        edit_contact_field("v1/contacts/#{id}/name", name)
+      end
+
+      def update_contact_company(id, company)
+        edit_contact_field("v1/contacts/#{id}/company", company)
+      end
+
+      def update_contact_picture(id, picture)
+        edit_contact_field("v1/contacts/#{id}/picture", picture)
+      end
+
+      def update_contact_address(id, address_id, address)
+        edit_contact_field("v1/contacts/#{id}/address/#{address_id}", address)
+      end
+
+      def update_contact_email(id, email_id, email)
+        edit_contact_field("v1/contacts/#{id}/email/#{email_id}", email)
+      end
+
+      def update_contact_phone(id, phone_id, phone)
+        edit_contact_field("v1/contacts/#{id}/phone/#{phone_id}", phone)
+      end
+
+      def update_contact_date(id, date_id, date)
+        edit_contact_field("v1/contacts/#{id}/date/#{date_id}", date)
+      end
+
+      def update_contact_note(id, note_id, note)
+        edit_contact_field("v1/contacts/#{id}/note/#{note_id}", note)
+      end
+
+      def update_contact_custom(id, custom_id, custom)
+        edit_contact_field("v1/contacts/#{id}/custom/#{custom_id}", custom)
+      end
+
+      def add_contact_address(id, address)
+        add_contact_field("v1/contacts/#{id}/address", address)
+      end
+
+      def add_contact_email(id, email)
+        add_contact_field("v1/contacts/#{id}/email", email)
+      end
+
+      def add_contact_phone(id, phone)
+        add_contact_field("v1/contacts/#{id}/phone", phone)
+      end
+
+      def add_contact_note(id, note)
+        add_contact_field("v1/contacts/#{id}/note", note)
+      end
+
+      def add_contact_custom(id, custom)
+        add_contact_field("v1/contacts/#{id}/custom", custom)
+      end
+
+      def add_contact_tags(id, tags)
+        add_contact_field("v1/contacts/#{id}/tags", tags)
+      end
+
+      private
+
+      def edit_contact_field(url, body)
+        perform_with_object(:put, url, Hive::Contact, body: body.to_json, params: { modifiedAt: Time.now.iso8601(3) })
+      end
+
+      def add_contact_field(url, body)
+        perform_with_object(:post, url, Hive::Contact, body: body.to_json, params: { modifiedAt: Time.now.iso8601(3) })
+      end
+    end
+  end
+end

data/lib/hive/rest/insights.rb

@@ -0,0 +1,17 @@
+require 'hive/activity_summary'
+
+module Hive
+  module REST
+    module Insights
+      include Hive::Util
+
+      def activities_summary(query_options = {})
+        perform_with_object(:get, 'v1/insights/activities/summary', Hive::ActivitySummary, params: query_options)
+      end
+
+      def contact_activities_summary(id, query_options = {})
+        perform_with_object(:get, "v1/insights/contacts/#{id}/activities/summary", Hive::ActivitySummary, params: query_options)
+      end
+    end
+  end
+end

data/lib/hive/util.rb

@@ -0,0 +1,20 @@
+require 'hive/connect/wix_client'
+
+module Hive
+  module Util
+    def perform(request_method, path, options = {})
+      request = Hive::Request::WixAPIRequest.new(self, request_method, path, options)
+      request.perform
+    end
+
+    def perform_with_object(request_method, path, klass, options = {})
+      request = Hive::Request::WixAPIRequest.new(self, request_method, path, options)
+      request.perform_with_object(klass)
+    end
+
+    def perform_with_cursor(request_method, path, klass, options = {})
+      request = Hive::Request::WixAPIRequest.new(self, request_method, path, options)
+      request.perform_with_cursor(klass)
+    end
+  end
+end

data/lib/hive/version.rb

@@ -0,0 +1,14 @@
+module Hive
+  class Version
+    MAJOR = 0
+    MINOR = 9
+    PATCH = 0
+
+    class << self
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR, PATCH].compact.join('.')
+      end
+    end
+  end
+end

data/lib/wix-hive-ruby.rb

@@ -0,0 +1,5 @@
+# Client
+require 'hive/connect/wix_client'
+
+# Extensions
+require 'hive/extensions/hashie_hash'

data/samples/quick_start.rb

@@ -0,0 +1,49 @@
+require 'sinatra'
+require 'wix-hive-ruby'
+
+SECRET_KEY = 'YOUR_SECRET_KEY'
+APP_ID = 'YOUR_APP_ID'
+
+# The route should match the app endpoint set during registration
+get '/' do
+  # The GET request to your app endpoint will contain an instance parameter for you to parse
+  instance = params.delete('instance')
+
+  # Parse the instance parameter
+  wixInstance = Hive::Client.parse_instance_data(instance, SECRET_KEY)
+
+  # Create a Wix Hive Client
+  client = Hive::Client.new do |config|
+    config.secret_key = SECRET_KEY
+    config.app_id = APP_ID
+    config.instance_id = wixInstance.instanceId
+  end
+
+  contact = Hive::Contact.new
+  contact.name.first = 'Quick'
+  contact.name.last = 'Start'
+  contact.add_email(email: 'quick.start@example.com', tag: 'work')
+  contact.add_phone(phone: '123456789', tag: 'work')
+  contact.add_url(url: 'wix.com', tag: 'site')
+
+  # Create a new contact
+  contact_res = client.new_contact(contact)
+
+  FACTORY = Hive::Activities
+  activity = Hive::Activity.new(
+      type: FACTORY::MUSIC_ALBUM_FAN.type,
+      locationUrl: 'http://www.wix.com',
+      details: { summary: 'test', additionalInfoUrl: 'http://www.wix.com' },
+      info: { album: { name: 'Wix', id: '1234' } })
+
+  # Add an activity to the contact
+  activity_res = client.add_contact_activity(contact_res.contactId, activity)
+
+  body "Contact created: #{contact_res.contactId}. 
+   Activity created: #{activity_res.activityId}
+   Thank you!"
+end
+
+after do
+  headers({ 'X-Frame-Options' => 'ALLOW-FROM wix.com' })
+end

data/spec/hive/activities/contact/contact_create_activity_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'CONTACTS_CREATE' do
+  subject(:create_activity) {ACTIVITIES_FACTORY::CONTACTS_CREATE.klass.new}
+
+  it '.add_email' do
+    create_activity.add_email( email: 'alex@example.com', tag: 'tag' )
+  end
+
+  it '.add_phone' do
+    create_activity.add_phone( phone: '123456789', tag: 'tag' )
+  end
+
+  it '.add_address' do
+    create_activity.add_address( tag: 'tag' )
+  end
+
+  it '.add_date' do
+    create_activity.add_date( date: 'date', tag: 'tag' )
+  end
+
+  it '.add_url' do
+    create_activity.add_url( url: 'wix.com', tag: 'tag' )
+  end
+end

data/spec/hive/activities/contact/contact_form_activity_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'CONTACT_CONTACT_FORM' do
+  subject(:create_activity) {ACTIVITIES_FACTORY::CONTACT_CONTACT_FORM.klass.new}
+
+  it '.add_field' do
+    create_activity.add_field( name: 'custom', value: 'value' )
+  end
+end

data/spec/hive/activities/conversion/conversion_complete_activity_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'CONVERSION_COMPLETE' do
+  subject(:create_activity) {ACTIVITIES_FACTORY::CONVERSION_COMPLETE.klass.new( conversionType: 'PAGEVIEW' )}
+
+  it '.add_metadata' do
+    create_activity.add_metadata( property: 'custom', value: 'value' )
+  end
+end

data/spec/hive/activities/e_commerce/purchase_activity_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'E_COMMERCE_PURCHASE' do
+  coupon = {total: '1', title: 'Dis'}
+  payment = {total: '1', subtotal: '1', currency: 'EUR', coupon: coupon}
+
+  subject(:create_activity) { ACTIVITIES_FACTORY::E_COMMERCE_PURCHASE.klass.new( cartId: '11111', storeId: '11111', payment: payment ) }
+
+  it '.add_item' do
+    create_activity.add_item( id: 1, title: 'title', quantity: 1, currency: 'EUR' )
+  end
+
+  context 'E_COMMERCE_PURCHASE::Item' do
+    it '.add_variant' do
+      create_activity.add_item( id: 1, title: 'title', quantity: 1, currency: 'EUR' )
+      create_activity.items.first.add_variant( title: 'title' )
+    end
+  end
+end

data/spec/hive/activities/factory_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Hive::Activities do
+
+  context 'factory methods' do
+    it '#CONTACT_CONTACT_FORM' do
+      expect(Hive::Activities::CONTACT_CONTACT_FORM.klass).to eq Hive::Activities.class_for_type(Hive::Activities::CONTACT_CONTACT_FORM.type)
+    end
+
+    it '#CONTACTS_CREATE' do
+      expect(Hive::Activities::CONTACTS_CREATE.klass).to eq Hive::Activities.class_for_type(Hive::Activities::CONTACTS_CREATE.type)
+    end
+
+    it '#CONVERSION_COMPLETE' do
+      expect(Hive::Activities::CONVERSION_COMPLETE.klass).to eq Hive::Activities.class_for_type(Hive::Activities::CONVERSION_COMPLETE.type)
+    end
+
+    it '#E_COMMERCE_PURCHASE' do
+      expect(Hive::Activities::E_COMMERCE_PURCHASE.klass).to eq Hive::Activities.class_for_type(Hive::Activities::E_COMMERCE_PURCHASE.type)
+    end
+
+    it '#MESSAGING_SEND' do
+      expect(Hive::Activities::MESSAGING_SEND.klass).to eq Hive::Activities.class_for_type(Hive::Activities::MESSAGING_SEND.type)
+    end
+
+    it '#MUSIC_ALBUM_FAN' do
+      expect(Hive::Activities::MUSIC_ALBUM_FAN.klass).to eq Hive::Activities.class_for_type(Hive::Activities::MUSIC_ALBUM_FAN.type)
+    end
+
+    it '#MUSIC_ALBUM_FAN' do
+      expect(Hive::Activities::MUSIC_ALBUM_SHARE.klass).to eq Hive::Activities.class_for_type(Hive::Activities::MUSIC_ALBUM_SHARE.type)
+    end
+
+    it '#MUSIC_TRACK_LYRICS' do
+      expect(Hive::Activities::MUSIC_TRACK_LYRICS.klass).to eq Hive::Activities.class_for_type(Hive::Activities::MUSIC_TRACK_LYRICS.type)
+    end
+
+    it '#MUSIC_TRACK_PLAY' do
+      expect(Hive::Activities::MUSIC_TRACK_PLAY.klass).to eq Hive::Activities.class_for_type(Hive::Activities::MUSIC_TRACK_PLAY.type)
+    end
+
+    it '#MUSIC_TRACK_PLAYED' do
+      expect(Hive::Activities::MUSIC_TRACK_PLAYED.klass).to eq Hive::Activities.class_for_type(Hive::Activities::MUSIC_TRACK_PLAYED.type)
+    end
+
+    it '#MUSIC_TRACK_SKIP' do
+      expect(Hive::Activities::MUSIC_TRACK_SKIP.klass).to eq Hive::Activities.class_for_type(Hive::Activities::MUSIC_TRACK_SKIP.type)
+    end
+
+    it '#MUSIC_TRACK_SHARE' do
+      expect(Hive::Activities::MUSIC_TRACK_SHARE.klass).to eq Hive::Activities.class_for_type(Hive::Activities::MUSIC_TRACK_SHARE.type)
+    end
+
+    # it '#HOTELS_CONFIRMATION' do
+    #   expect(Hive::Activities::HOTELS_CONFIRMATION.klass).to eq Hive::Activities.class_for_type(Hive::Activities::HOTELS_CONFIRMATION.type)
+    # end
+
+    it '#HOTELS_CANCEL' do
+      expect(Hive::Activities::HOTELS_CANCEL.klass).to eq Hive::Activities.class_for_type(Hive::Activities::HOTELS_CANCEL.type)
+    end
+
+    it '#HOTELS_PURCHASE' do
+      expect(Hive::Activities::HOTELS_PURCHASE.klass).to eq Hive::Activities.class_for_type(Hive::Activities::HOTELS_PURCHASE.type)
+    end
+
+    it '#HOTELS_PURCHASE_FAILED' do
+      expect(Hive::Activities::HOTELS_PURCHASE_FAILED.klass).to eq Hive::Activities.class_for_type(Hive::Activities::HOTELS_PURCHASE_FAILED.type)
+    end
+
+    it '#SCHEDULER_APPOINTMENT' do
+      expect(Hive::Activities::SCHEDULER_APPOINTMENT.klass).to eq Hive::Activities.class_for_type(Hive::Activities::SCHEDULER_APPOINTMENT.type)
+    end
+
+    it 'Invalid type' do
+      expect(Hive::Activities.class_for_type('invalid')).to be_nil
+    end
+  end
+end

data/spec/hive/activities/hotels/hotels_cancel_activity_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'HOTELS_CANCEL' do
+  guest = { total: 1, adults: 1, children: 0 }
+
+  day_ago = (Time.now - (60 * 60 * 24)).iso8601(3)
+  stay = { checkin: day_ago, checkout: Time.now.iso8601(3) }
+
+  invoice = {total: '1', subtotal: '1', currency: 'EUR'}
+
+  refund = {kind: 'FULL', total: 1, currency: 'EUR', destination: 'NYC'}
+
+  subject(:create_activity) {ACTIVITIES_FACTORY::HOTELS_CANCEL.klass.new( cancelDate: day_ago, refund: refund, guests: guest, stay: stay, invoice: invoice ) }
+
+  it '.add_rate' do
+    create_activity.add_rate( date: 'date', subtotal: '1', total: '1', currency: 'EUR' )
+  end
+
+  it '.add_room' do
+    create_activity.add_room( maxOccupancy: 1 )
+  end
+end

data/spec/hive/activities/hotels/hotels_confirmation_activity_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'HOTELS_CONFIRMATION' do
+  guest = { total: 1, adults: 1, children: 0 }
+
+  day_ago = (Time.now - (60 * 60 * 24)).iso8601(3)
+  stay = { checkin: day_ago, checkout: Time.now.iso8601(3) }
+
+  invoice = {total: '1', subtotal: '1', currency: 'EUR'}
+
+  subject(:create_activity) {ACTIVITIES_FACTORY::HOTELS_CONFIRMATION.klass.new( source: 'GUEST', guests: guest, stay: stay, invoice: invoice  ) }
+
+  it '.add_rate' do
+    create_activity.add_rate( date: 'date', subtotal: '1', total: '1', currency: 'EUR' )
+  end
+
+  it '.add_room' do
+    create_activity.add_room( maxOccupancy: 1 )
+  end
+
+  context 'HOTELS_CONFIRMATION::Bed' do
+    it '.add_bed' do
+      create_activity.add_room( maxOccupancy: 1 )
+      create_activity.rooms.first.add_bed( kind: 'king' )
+    end
+  end
+
+  context 'HOTELS_CONFIRMATION::Rate' do
+    it '.add_tax' do
+      create_activity.add_rate( date: 'date', subtotal: '1', total: '1', currency: 'EUR' )
+      create_activity.rates.first.add_tax( name: 'VAT', total: '1', currency: 'EUR')
+    end
+  end
+end