Ruby Bindings for E-Commerce Tutorial - Revision history

Scott at 23:12, 4 April 2013

2013-04-04T23:12:30Z

Scott: /* Setting up the Ruby plumbing */

2009-05-28T06:24:01Z

‎Setting up the Ruby plumbing

Scott at 11:08, 26 May 2009

2009-05-26T11:08:29Z

Scott: /* Adding new users / products */

2009-05-25T17:39:00Z

‎Adding new users / products

Scott: /* Finding related products */

2009-05-25T17:35:51Z

‎Finding related products

Scott: /* Delivering personalized recommendations */

2009-05-25T17:35:32Z

‎Delivering personalized recommendations

Scott: /* Adding a new purchase */

2009-05-25T17:35:20Z

‎Adding a new purchase

Scott: /* Importing the XML to the Directed Edge servers */

2009-05-25T17:35:08Z

‎Importing the XML to the Directed Edge servers

Scott: /* Let's give it a spin */

2009-05-25T17:34:45Z

‎Let's give it a spin

Scott: /* Delivering personalized recommendations */

2009-05-25T17:32:00Z

‎Delivering personalized recommendations

@@ Line 133: / Line 133: @@
 For those not coming from a Rails background, things like the code to find all purchases matching a given customer ID might seem a bit off the wall:
-<pre>Purchase.find(:all, :conditions => { :customer => customer.id })</pre>
+<source lang="ruby">Purchase.find(:all, :conditions => { :customer => customer.id })</source>
 That little thinger there does just what we described above &mdash; produces a list of all rows in the purchases table that have the customer ID specified.  ActiveRecord also automatically creates class accessors for each column of a table, so the ''.id'' there just corresponds to that column in the customers table.

@@ Line 64: / Line 64: @@
 == Setting up the Ruby plumbing ==
-Here we just do the standard ruby ''hashbang'' and import three modules.  Ruby gems is required since we've pulled in ''activerecord'' via [http://rubygems.org/ gem].  [http://ar.rubyonrails.org/ ActiveRecord] is the object relational mapping that is standard with [http://rubyonrails.org/ Ruby on Rails] and we'll be using it to access our MySQL database.  And finally, we use the [[http://github.com/directededge/directed-edge-bindings/tree/master Ruby bindings] for the Directed Edge API.
+Here we just do the standard ruby ''hashbang'' and import three modules.  Ruby gems is required since we've pulled in ''activerecord'' via [http://rubygems.org/ gem].  [http://ar.rubyonrails.org/ ActiveRecord] is the object relational mapping that is standard with [http://rubyonrails.org/ Ruby on Rails] and we'll be using it to access our MySQL database.  And finally, we use the [http://github.com/directededge/directed-edge-bindings/tree/master Ruby bindings] for the Directed Edge API.
 <source lang="ruby">

← Older revision		Revision as of 11:08, 26 May 2009
Line 2:		Line 2:

	'''If you want to see all of the code in one go, you can get it in full syntax-highlighted glory here: [[ExampleStore Class]], or download it [[Media:example_store.rb\|here]]. You'll also want our Ruby bindings, which you can get from GitHub [http://github.com/directededge/directed-edge-bindings/blob/6f5f421d25f4b43e6b39cb35702987b5598cc85f/Ruby/directed_edge.rb here] ([http://github.com/directededge/directed-edge-bindings/raw/6f5f421d25f4b43e6b39cb35702987b5598cc85f/Ruby/directed_edge.rb download]).'''		'''If you want to see all of the code in one go, you can get it in full syntax-highlighted glory here: [[ExampleStore Class]], or download it [[Media:example_store.rb\|here]]. You'll also want our Ruby bindings, which you can get from GitHub [http://github.com/directededge/directed-edge-bindings/blob/6f5f421d25f4b43e6b39cb35702987b5598cc85f/Ruby/directed_edge.rb here] ([http://github.com/directededge/directed-edge-bindings/raw/6f5f421d25f4b43e6b39cb35702987b5598cc85f/Ruby/directed_edge.rb download]).'''
		+
		+	Not a Rubyist? No problem. You can use our API from any programming language, the language bindings just make things a little easier. You still may get something out of reading through the example here to get a feel for the integration process.

	== Creating the testing database ==		== Creating the testing database ==

@@ Line 226: / Line 226: @@
    # Creates a new customer in the Directed Edge database that corresponds to the
    # given customer ID
    def create_customer(id)
      item = DirectedEdge::Item.new(@database, "customer#{id}")
@@ Line 235: / Line 234: @@
    # Creates a new product in the Directed Edge database that corresponds to the
    # given product ID
    def create_product(id)
      item = DirectedEdge::Item.new(@database, "product#{id}")

@@ Line 272: / Line 272: @@
 <source lang="ruby">
    # Returns a list of product IDs related to the given product ID
    def related_products(product_id)
      item = DirectedEdge::Item.new(@database, "product#{product_id}")

@@ Line 287: / Line 287: @@
 <source lang="ruby">
    # Returns a list of personalized recommendations for the given customer ID
    def personalized_recommendations(customer_id)
      item = DirectedEdge::Item.new(@database, "customer#{customer_id}")

@@ Line 253: / Line 253: @@
 <source lang="ruby">
    # Notes in the Directed Edge database that customer_id purchased product_id
    def add_purchase(customer_id, product_id)
      item = DirectedEdge::Item.new(@database, "customer#{customer_id}")

@@ Line 206: / Line 206: @@
 <source lang="ruby">
    # Imports the file exported from the export method to the Directed Edge database
    def import_to_directededge
      @database.import('examplestore.xml')

@@ Line 317: / Line 317: @@
 # Export the contents of our MySQL database to XML
 store.export_from_mysql
 # Import that XML to the Directed Edge database
 store.import_to_directededge
 # Add a new customer
 store.create_customer(500)
 # Add a new product
 store.create_product(2000)
 # Set that user as having purchased that product
 store.add_purchase(500, 2000)
 # Find related products for the product with the ID 1 (in MySQL)
 store.related_products(1).each do |product|
    puts "Related products for product 1: #{product}"
@@ Line 343: / Line 337: @@
 # Find personalized recommendations for the user with the ID 1 (in MySQL)
 store.personalized_recommendations(1).each do |product|
    puts "Personalized recommendations for user 1: #{product}"

← Older revision		Revision as of 17:32, 25 May 2009
Line 295:		Line 295:
	end		end
	</source>		</source>
		+
		+	== Let's give it a spin ==
		+
		+	So, now we've finished defining our class, let's do something with it!
		+
		+	The example below shows:
		+
		+	* Last line of the class definition (end)
		+	* Exports the MySQL database to a file
		+	* Sends that file up to the Directed Edge servers
		+	* Creates a new customer (with ID 500), updating the MySQL database is left up to the reader
		+	* Creates a new product (with ID 2000)
		+	* Creates a new purchase (with the customer and product we just created)
		+	* Retrieves and prints products related to the product with the (MySQL) ID of 1
		+	* Retrieves and prints personalized recommendations for the user with the (MySQL) ID of 1
		+
		+	<source lang="ruby">
		+	end
		+
		+	store = ExampleStore.new
		+
		+	# Export the contents of our MySQL database to XML
		+
		+	store.export_from_mysql
		+
		+	# Import that XML to the Directed Edge database
		+
		+	store.import_to_directededge
		+
		+	# Add a new customer
		+
		+	store.create_customer(500)
		+
		+	# Add a new product
		+
		+	store.create_product(2000)
		+
		+	# Set that user as having purchased that product
		+
		+	store.add_purchase(500, 2000)
		+
		+	# Find related products for the product with the ID 1 (in MySQL)
		+
		+	store.related_products(1).each do \|product\|
		+	puts "Related products for product 1: #{product}"
		+	end
		+
		+	# Find personalized recommendations for the user with the ID 1 (in MySQL)
		+
		+	store.personalized_recommendations(1).each do \|product\|
		+	puts "Personalized recommendations for user 1: #{product}"
		+	end
		+	</source>
		+
		+	== See also ==
		+
		+	* [[ExampleStore Class]] - full source in one place of all of the examples covered here
		+	* [[API Concepts]] - a refresher on the concepts at work here
		+	* [[REST API]] and [[XML Format]] - A peek into what's going on behind the scenes