wix-hive-ruby 0.9.0

data/e2e/e2e_helper.rb

@@ -0,0 +1,35 @@
+require 'wix-hive-ruby'
+require 'time'
+require 'vcr'
+
+RECORD_MODE =  ENV['ACCEPTANCE']  ? :all : :new_episodes
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'e2e/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end
+
+RSpec.configure do |config|
+  # Disable the use of 'should' as it is deprecated!
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.around(:each) do |example|
+    VCR.use_cassette(example.metadata[:full_description], :match_requests_on => [:path], :record => RECORD_MODE) do
+      example.run
+    end
+  end
+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'
+  end
+end
+
+def pendingImpl
+  pending 'To be implemented'
+end

data/e2e/insights_api_spec.rb

@@ -0,0 +1,29 @@
+require_relative './e2e_helper'
+
+describe 'Insights API' do
+  it '.activities_summary' do
+    expect(client.activities_summary).to be_a Hive::ActivitySummary
+  end
+
+  it '.contact_activities_summary' do
+    contact = Hive::Contact.new
+    contact.name.first = 'Wix'
+    contact.name.last = 'Cool'
+    contact.add_email(email: 'alext@wix.com', tag: 'work')
+    contact.add_phone(phone: '123456789', tag: 'work')
+
+    create_contact = client.new_contact(contact)
+
+    expect(create_contact).to include :contactId
+
+    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' } })
+
+    client.add_contact_activity(create_contact[:contactId], activity)
+
+    expect(client.contact_activities_summary(create_contact[:contactId])).to be_a Hive::ActivitySummary
+  end
+end

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

@@ -0,0 +1,109 @@
+# THIS IS A GENERATED FILE, DO NOT EDIT THIS
+# Generated on 2014-09-10T14:02:21.470Z
+
+require 'hashie'
+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
+
+        property :name
+        property :role
+      end
+
+      class Email < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :tag, required: true
+        property :email, required: true
+      end
+
+      class Phone < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :tag, required: true
+        property :phone, required: true
+      end
+
+      class Address < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :tag, required: true
+        property :address
+        property :city
+        property :region
+        property :postalCode
+        property :country
+      end
+
+      class Date < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :tag, required: true
+        property :date, required: true
+      end
+
+      class Url < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :tag, required: true
+        property :url, required: true
+      end
+
+      class CreateActivity < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+        include Hashie::Extensions::Coercion
+
+        coerce_key :name, Name
+        coerce_key :company, Company
+        coerce_key :emails, Array[Email]
+        coerce_key :phones, Array[Phone]
+        coerce_key :addresses, Array[Address]
+        coerce_key :dates, Array[Date]
+        coerce_key :urls, Array[Url]
+
+        property :name
+        property :picture
+        property :company
+        property :emails, default: [], required: true
+        property :phones, default: [], required: true
+        property :addresses, default: [], required: true
+        property :dates, default: [], required: true
+        property :urls, default: [], required: true
+
+        def add_email(args)
+          emails << Email.new(args)
+        end
+
+        def add_phone(args)
+          phones << Phone.new(args)
+        end
+
+        def add_address(args)
+          addresses << Address.new(args)
+        end
+
+        def add_date(args)
+          dates << Date.new(args)
+        end
+
+        def add_url(args)
+          urls << Url.new(args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# THIS IS A GENERATED FILE, DO NOT EDIT THIS
+# Generated on 2014-09-10T14:02:21.439Z
+
+require 'hashie'
+require 'hive/extensions/hashie_validate_enum'
+
+module Hive
+  module Activities
+    module Contact
+      class Field < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :name, required: true
+        property :value, required: true
+      end
+
+      class FormActivity < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+        include Hashie::Extensions::Coercion
+
+        coerce_key :fields, Array[Field]
+
+        property :fields, default: [], required: true
+
+        def add_field(args)
+          fields << Field.new(args)
+        end
+      end
+    end
+  end
+end

data/lib/hive/activities/conversion/conversion_complete_activity.rb

@@ -0,0 +1,33 @@
+# THIS IS A GENERATED FILE, DO NOT EDIT THIS
+# Generated on 2014-09-10T14:02:21.479Z
+
+require 'hashie'
+require 'hive/extensions/hashie_validate_enum'
+
+module Hive
+  module Activities
+    module Conversion
+      class Metadata < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :property, required: true
+        property :value, required: true
+      end
+
+      class CompleteActivity < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+        include Hashie::Extensions::Coercion
+
+        coerce_key :metadata, Array[Metadata]
+
+        property :conversionType, required: true, transform_with: Hashie::Validate.enum(%w(PAGEVIEW PURCHASE UPGRADE LIKE FAN NONE))
+        property :messageId
+        property :metadata, default: []
+
+        def add_metadata(args)
+          metadata << Metadata.new(args)
+        end
+      end
+    end
+  end
+end

data/lib/hive/activities/e_commerce/purchase_activity.rb

@@ -0,0 +1,150 @@
+# THIS IS A GENERATED FILE, DO NOT EDIT THIS
+# Generated on 2014-09-10T14:02:21.514Z
+
+require 'hashie'
+require 'hive/extensions/hashie_validate_enum'
+
+module Hive
+  module Activities
+    module ECommerce
+      class Media < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :thumbnail
+      end
+
+      class Variant < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :title, required: true
+        property :value
+      end
+
+      class Item < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+        include Hashie::Extensions::Coercion
+
+        coerce_key :media, Media
+        coerce_key :variants, Array[Variant]
+
+        property :id, required: true
+        property :sku
+        property :title, required: true
+        property :quantity, required: true
+        property :price
+        property :formattedPrice
+        property :currency, required: true
+        property :productLink
+        property :weight
+        property :formattedWeight
+        property :media
+        property :variants, default: [], required: true
+
+        def add_variant(args)
+          variants << Variant.new(args)
+        end
+      end
+
+      class Coupon < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :total, required: true
+        property :formattedTotal
+        property :title, required: true
+      end
+
+      class Tax < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :total, required: true
+        property :formattedTotal
+      end
+
+      class Shipping < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :total, required: true
+        property :formattedTotal
+      end
+
+      class Payment < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+        include Hashie::Extensions::Coercion
+
+        coerce_key :coupon, Coupon
+        coerce_key :tax, Tax
+        coerce_key :shipping, Shipping
+
+        property :total, required: true
+        property :subtotal, required: true
+        property :formattedTotal
+        property :formattedSubtotal
+        property :currency, required: true
+        property :coupon
+        property :tax
+        property :shipping
+      end
+
+      class ShippingAddres < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :firstName
+        property :lastName
+        property :email
+        property :phone
+        property :country
+        property :countryCode
+        property :region
+        property :regionCode
+        property :city
+        property :address1
+        property :address2
+        property :zip
+        property :company
+      end
+
+      class BillingAddres < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+
+        property :firstName
+        property :lastName
+        property :email
+        property :phone
+        property :country
+        property :countryCode
+        property :region
+        property :regionCode
+        property :city
+        property :address1
+        property :address2
+        property :zip
+        property :company
+      end
+
+      class PurchaseActivity < Hashie::Trash
+        include Hashie::Extensions::IgnoreUndeclared
+        include Hashie::Extensions::Coercion
+
+        coerce_key :items, Array[Item]
+        coerce_key :payment, Payment
+        coerce_key :shippingAddress, ShippingAddres
+        coerce_key :billingAddress, BillingAddres
+
+        property :cartId, required: true
+        property :storeId, required: true
+        property :orderId
+        property :items, default: [], required: true
+        property :payment, required: true
+        property :shippingAddress
+        property :billingAddress
+        property :paymentGateway
+        property :note
+        property :buyerAcceptsMarketing
+
+        def add_item(args)
+          items << Item.new(args)
+        end
+      end
+    end
+  end
+end

data/lib/hive/activities/factory.rb

@@ -0,0 +1,71 @@
+# THIS IS A GENERATED FILE, DO NOT EDIT THIS
+# Generated on 2014-09-10T14:02:21.632Z
+
+require 'hive/activities/contact/contact_form_activity'
+require 'hive/activities/contact/contact_create_activity'
+require 'hive/activities/conversion/conversion_complete_activity'
+require 'hive/activities/e_commerce/purchase_activity'
+require 'hive/activities/messaging/send_activity'
+require 'hive/activities/music/album_fan_activity'
+require 'hive/activities/music/album_share_activity'
+require 'hive/activities/music/track_lyrics_activity'
+require 'hive/activities/music/track_play_activity'
+require 'hive/activities/music/track_played_activity'
+require 'hive/activities/music/track_skipped_activity'
+require 'hive/activities/music/track_share_activity'
+require 'hive/activities/hotels/hotels_confirmation_activity'
+require 'hive/activities/hotels/hotels_cancel_activity'
+require 'hive/activities/hotels/hotels_purchase_activity'
+require 'hive/activities/hotels/hotels_purchase_failed_activity'
+require 'hive/activities/scheduler/scheduler_appointment_activity'
+
+module Hive
+  module Activities
+    ActivityType = Struct.new(:klass, :type) do
+    end
+
+    CONTACT_CONTACT_FORM = ActivityType.new(Contact::FormActivity, 'contact/contact-form')
+
+    CONTACTS_CREATE = ActivityType.new(Contact::CreateActivity, 'contacts/create')
+
+    CONVERSION_COMPLETE = ActivityType.new(Conversion::CompleteActivity, 'conversion/complete')
+
+    E_COMMERCE_PURCHASE = ActivityType.new(ECommerce::PurchaseActivity, 'e_commerce/purchase')
+
+    MESSAGING_SEND = ActivityType.new(Messaging::SendActivity, 'messaging/send')
+
+    MUSIC_ALBUM_FAN = ActivityType.new(Music::FanActivity, 'music/album-fan')
+
+    MUSIC_ALBUM_SHARE = ActivityType.new(Music::ShareActivity, 'music/album-share')
+
+    MUSIC_TRACK_LYRICS = ActivityType.new(Music::LyricsActivity, 'music/track-lyrics')
+
+    MUSIC_TRACK_PLAY = ActivityType.new(Music::TrackPlayActivity, 'music/track-play')
+
+    MUSIC_TRACK_PLAYED = ActivityType.new(Music::TrackPlayedActivity, 'music/track-played')
+
+    MUSIC_TRACK_SKIP = ActivityType.new(Music::TrackSkippedActivity, 'music/track-skip')
+
+    MUSIC_TRACK_SHARE = ActivityType.new(Music::TrackShareActivity, 'music/track-share')
+
+    HOTELS_CONFIRMATION = ActivityType.new(Hotels::ConfirmationActivity, 'hotels/confirmation')
+
+    HOTELS_CANCEL = ActivityType.new(Hotels::CancelActivity, 'hotels/cancel')
+
+    HOTELS_PURCHASE = ActivityType.new(Hotels::PurchaseActivity, 'hotels/purchase')
+
+    HOTELS_PURCHASE_FAILED = ActivityType.new(Hotels::PurchaseFailedActivity, 'hotels/purchase-failed')
+
+    SCHEDULER_APPOINTMENT = ActivityType.new(Scheduler::AppointmentActivity, 'scheduler/appointment')
+
+    TYPES = [CONTACT_CONTACT_FORM, CONTACTS_CREATE, CONVERSION_COMPLETE, E_COMMERCE_PURCHASE, MESSAGING_SEND, MUSIC_ALBUM_FAN, MUSIC_ALBUM_SHARE, MUSIC_TRACK_LYRICS, MUSIC_TRACK_PLAY, MUSIC_TRACK_PLAYED, MUSIC_TRACK_SKIP, MUSIC_TRACK_SHARE, HOTELS_CONFIRMATION, HOTELS_CANCEL, HOTELS_PURCHASE, HOTELS_PURCHASE_FAILED, SCHEDULER_APPOINTMENT]
+
+    module_function
+
+    def class_for_type(type)
+      result = TYPES.find { |i| i.type == type }
+
+      result.klass unless result.nil?
+    end
+  end
+end