crystal_api 0.0.1

data/lib/crystal_api/variant_descriptor.rb

@@ -0,0 +1,10 @@
+module CrystalApi
+  class VariantDescriptor
+    include Attributes
+
+    root_element :variant_descriptor
+
+    string_attribute :name
+    string_attribute :value
+  end
+end

data/lib/crystal_api/version.rb

@@ -0,0 +1,3 @@
+module CrystalApi
+  VERSION = "0.0.1"
+end

data/lib/crystal_api/webhook.rb

@@ -0,0 +1,15 @@
+module CrystalApi
+  class Webhook
+    include Attributes
+
+    root_element :webhook
+
+    integer_attribute :id
+    integer_attribute :resource_id
+
+    string_attribute :address
+    string_attribute :topic
+
+    boolean_attribute :only_catalog
+  end
+end

data/lib/crystal_api/webhook_envelope.rb

@@ -0,0 +1,12 @@
+module CrystalApi
+  class WebhookEnvelope
+    include Attributes
+
+    root_element :webhook_envelope
+
+    string_attribute :topic
+    string_attribute :store_name
+    integer_attribute :resource_id
+    attribute :payload
+  end
+end

data/lib/crystal_api/webhook_registration.rb

@@ -0,0 +1,34 @@
+module CrystalApi
+  class WebhookRegistration
+    attr_reader :endpoint
+
+    def initialize(endpoint)
+      @endpoint = endpoint
+    end
+
+    def register(webhook)
+      endpoint.post('/webhooks', webhook.to_json(:except => [:id]))
+    end
+
+    def registered?(webhook)
+      registered_webhooks.any? {|wh| wh.address == webhook.address &&
+                                     wh.topic   == webhook.topic &&
+                                     wh.resource_id == webhook.resource_id }
+    end
+
+    def deregister(webhook_id)
+      endpoint.delete("/webhooks/#{webhook_id}")
+    end
+
+    def registered_webhooks
+      endpoint.get('/webhooks').parsed
+    end
+
+    def webhook_id(webhook)
+      wh = registered_webhooks.detect {|wh| wh.address == webhook.address &&
+                                       wh.topic   == webhook.topic &&
+                                       wh.resource_id == webhook.resource_id }
+      wh && wh.id
+    end
+  end
+end

data/lib/crystal_api/webhook_verifier.rb

@@ -0,0 +1,20 @@
+module CrystalApi
+  class WebhookVerifier
+    include HmacRequestSigning
+
+    attr_reader :secret_signing_key, :request
+
+    def initialize(secret_signing_key, request)
+      @secret_signing_key = secret_signing_key
+      @request = request
+    end
+
+    def verified?
+      request_signature(request) == expected_signature
+    end
+
+    def expected_signature
+      hmac_sha256(secret_signing_key, request.raw_post)
+    end
+  end
+end

data/spec/cassettes/CrystalApi_StoreEndpoint/_get/prefs/store/makes_the_request_to_the_endpoint.yml

@@ -0,0 +1,67 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/prefs/store
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - OAuth TOKEN
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: ! 'OK '
+    headers:
+      Etag:
+      - ! '"62dbdcce719c67de7a0eee8d9e92ea2c"'
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Md5:
+      - 62dbdcce719c67de7a0eee8d9e92ea2c
+      Connection:
+      - Keep-Alive
+      Server:
+      - WEBrick/1.3.1 (Ruby/1.8.7/2012-02-08)
+      X-Runtime:
+      - '211'
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Date:
+      - Thu, 24 Jan 2013 04:45:30 GMT
+      Cache-Control:
+      - private, max-age=0, must-revalidate
+      Content-Length:
+      - '2498'
+      Access-Control-Expose-Headers:
+      - content-type, content-md5, x-oauth-scopes, x-accepted-oauth-scopes, content-length,
+        cache-control
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Headers:
+      - origin, authorization, content-type, accept
+      Set-Cookie:
+      - _admin_session=d7405de32bc2300e951a253d069ad71d; path=/; expires=Fri, 25-Jan-2013
+        00:45:30 GMT; HttpOnly
+    body:
+      encoding: US-ASCII
+      string: ! '{"store_prefs":{"buylist_email":"donald@crystalcommerce.com","satisfaction_blurb":"Our
+        #1 goal is making sure you''re happy with your purchase today. Happy customers
+        come back soon and tell their friends. Its a win, win.","enable_frontend_auto_translate":false,"logo_photo":{"photo":{"is_default":false,"urls":{"large":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/large/arux-banner.png"},"medium":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/medium/arux-banner.png"},"original":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/arux-banner.png"},"huge":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/huge/arux-banner.png"},"thumb":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/thumb/arux-banner.png"}}}},"return_blurb":"If
+        your order ever arrives in less than expected condition, please promptly return
+        it to us for a full refund. We take your business with us very seriously.","time_zone":"Pacific
+        Time (US & Canada)","city":"Seattle","hostname":"store.arux.net","customer_service_phone":"555-555-5555","zip":"98125","sales_tax":"9","cancel":"14","default_currency_code":"USD","default_locale":"x-bork","privacy_blurb":"We
+        promise to never ever sell your personal private information to any 3rd party
+        company! We hate spam too. Order today with confidence.","enable_manual_credit_card_capture":false,"store_credit_multiplier":"1.3","buylist_cancel_days":"0","checkout_special_instructions":"","default_exchange_rate":"1","enable_buy_order_notifications":"1","enable_buylist":true,"enable_bcc_buylist_confirmation_emails":false,"enable_tax_on_shipping":true,"enable_sort_by_price":true,"feedback_timespan":"14","home_redirect":"/catalog/magic_singles-core_sets-magic_2012/306","phone":"555-555-5555","state":"WA","enable_referafriend":true,"address":"3400
+        NE 110th ST #B-1","payment":"7","contact_name":"Mr. Arux","name":"Arux Gaming
+        and Hobbies","display_customer_service_phone":false,"enable_order_notifications":"1","enable_account_approval":false,"enable_watermarking_of_product_photos":false,"watermark_photo":null,"country":"US","contact_email":"donald@crystalcommerce.com","buylist_reminder_days":"0","hide_bank_transfer_details_in_emails":false,"enable_invoice_logo":false}}'
+    http_version: 
+  recorded_at: Thu, 24 Jan 2013 04:45:30 GMT
+recorded_with: VCR 2.2.4

data/spec/cassettes/CrystalApi_StoreEndpoint/_get/prefs/store/parses_the_returned_a_store_pref.yml

@@ -0,0 +1,67 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/prefs/store
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - OAuth TOKEN
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: ! 'OK '
+    headers:
+      Etag:
+      - ! '"62dbdcce719c67de7a0eee8d9e92ea2c"'
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Md5:
+      - 62dbdcce719c67de7a0eee8d9e92ea2c
+      Connection:
+      - Keep-Alive
+      Server:
+      - WEBrick/1.3.1 (Ruby/1.8.7/2012-02-08)
+      X-Runtime:
+      - '64'
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Date:
+      - Thu, 24 Jan 2013 05:14:11 GMT
+      Cache-Control:
+      - private, max-age=0, must-revalidate
+      Content-Length:
+      - '2498'
+      Access-Control-Expose-Headers:
+      - content-type, content-md5, x-oauth-scopes, x-accepted-oauth-scopes, content-length,
+        cache-control
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Headers:
+      - origin, authorization, content-type, accept
+      Set-Cookie:
+      - _admin_session=d989077369170dfdbfee1b5607371d27; path=/; expires=Fri, 25-Jan-2013
+        01:14:11 GMT; HttpOnly
+    body:
+      encoding: US-ASCII
+      string: ! '{"store_prefs":{"buylist_email":"donald@crystalcommerce.com","satisfaction_blurb":"Our
+        #1 goal is making sure you''re happy with your purchase today. Happy customers
+        come back soon and tell their friends. Its a win, win.","enable_frontend_auto_translate":false,"logo_photo":{"photo":{"is_default":false,"urls":{"large":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/large/arux-banner.png"},"medium":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/medium/arux-banner.png"},"original":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/arux-banner.png"},"huge":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/huge/arux-banner.png"},"thumb":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/thumb/arux-banner.png"}}}},"return_blurb":"If
+        your order ever arrives in less than expected condition, please promptly return
+        it to us for a full refund. We take your business with us very seriously.","time_zone":"Pacific
+        Time (US & Canada)","city":"Seattle","hostname":"store.arux.net","customer_service_phone":"555-555-5555","zip":"98125","sales_tax":"9","cancel":"14","default_currency_code":"USD","default_locale":"x-bork","privacy_blurb":"We
+        promise to never ever sell your personal private information to any 3rd party
+        company! We hate spam too. Order today with confidence.","enable_manual_credit_card_capture":false,"store_credit_multiplier":"1.3","buylist_cancel_days":"0","checkout_special_instructions":"","default_exchange_rate":"1","enable_buy_order_notifications":"1","enable_buylist":true,"enable_bcc_buylist_confirmation_emails":false,"enable_tax_on_shipping":true,"enable_sort_by_price":true,"feedback_timespan":"14","home_redirect":"/catalog/magic_singles-core_sets-magic_2012/306","phone":"555-555-5555","state":"WA","enable_referafriend":true,"address":"3400
+        NE 110th ST #B-1","payment":"7","contact_name":"Mr. Arux","name":"Arux Gaming
+        and Hobbies","display_customer_service_phone":false,"enable_order_notifications":"1","enable_account_approval":false,"enable_watermarking_of_product_photos":false,"watermark_photo":null,"country":"US","contact_email":"donald@crystalcommerce.com","buylist_reminder_days":"0","hide_bank_transfer_details_in_emails":false,"enable_invoice_logo":false}}'
+    http_version: 
+  recorded_at: Thu, 24 Jan 2013 05:14:11 GMT
+recorded_with: VCR 2.2.4

data/spec/cassettes/CrystalApi_StoreEndpoint/_get/prefs/store/returns_a_store_pref_instance.yml

@@ -0,0 +1,67 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/prefs/store
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - OAuth TOKEN
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: ! 'OK '
+    headers:
+      Etag:
+      - ! '"62dbdcce719c67de7a0eee8d9e92ea2c"'
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Md5:
+      - 62dbdcce719c67de7a0eee8d9e92ea2c
+      Connection:
+      - Keep-Alive
+      Server:
+      - WEBrick/1.3.1 (Ruby/1.8.7/2012-02-08)
+      X-Runtime:
+      - '58'
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Date:
+      - Thu, 24 Jan 2013 04:47:04 GMT
+      Cache-Control:
+      - private, max-age=0, must-revalidate
+      Content-Length:
+      - '2498'
+      Access-Control-Expose-Headers:
+      - content-type, content-md5, x-oauth-scopes, x-accepted-oauth-scopes, content-length,
+        cache-control
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Headers:
+      - origin, authorization, content-type, accept
+      Set-Cookie:
+      - _admin_session=ebb621b076e457c5da22fb012b437686; path=/; expires=Fri, 25-Jan-2013
+        00:47:04 GMT; HttpOnly
+    body:
+      encoding: US-ASCII
+      string: ! '{"store_prefs":{"buylist_email":"donald@crystalcommerce.com","satisfaction_blurb":"Our
+        #1 goal is making sure you''re happy with your purchase today. Happy customers
+        come back soon and tell their friends. Its a win, win.","enable_frontend_auto_translate":false,"logo_photo":{"photo":{"is_default":false,"urls":{"large":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/large/arux-banner.png"},"medium":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/medium/arux-banner.png"},"original":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/arux-banner.png"},"huge":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/huge/arux-banner.png"},"thumb":{"href":"http://crystalcommerce-development.s3.amazonaws.com/photo/arux/file/8e233b1f3da489341a9d55a1ca744556/thumb/arux-banner.png"}}}},"return_blurb":"If
+        your order ever arrives in less than expected condition, please promptly return
+        it to us for a full refund. We take your business with us very seriously.","time_zone":"Pacific
+        Time (US & Canada)","city":"Seattle","hostname":"store.arux.net","customer_service_phone":"555-555-5555","zip":"98125","sales_tax":"9","cancel":"14","default_currency_code":"USD","default_locale":"x-bork","privacy_blurb":"We
+        promise to never ever sell your personal private information to any 3rd party
+        company! We hate spam too. Order today with confidence.","enable_manual_credit_card_capture":false,"store_credit_multiplier":"1.3","buylist_cancel_days":"0","checkout_special_instructions":"","default_exchange_rate":"1","enable_buy_order_notifications":"1","enable_buylist":true,"enable_bcc_buylist_confirmation_emails":false,"enable_tax_on_shipping":true,"enable_sort_by_price":true,"feedback_timespan":"14","home_redirect":"/catalog/magic_singles-core_sets-magic_2012/306","phone":"555-555-5555","state":"WA","enable_referafriend":true,"address":"3400
+        NE 110th ST #B-1","payment":"7","contact_name":"Mr. Arux","name":"Arux Gaming
+        and Hobbies","display_customer_service_phone":false,"enable_order_notifications":"1","enable_account_approval":false,"enable_watermarking_of_product_photos":false,"watermark_photo":null,"country":"US","contact_email":"donald@crystalcommerce.com","buylist_reminder_days":"0","hide_bank_transfer_details_in_emails":false,"enable_invoice_logo":false}}'
+    http_version: 
+  recorded_at: Thu, 24 Jan 2013 04:47:04 GMT
+recorded_with: VCR 2.2.4

data/spec/crystal_api/attributes_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe CrystalApi::Attributes do
+  class TestAttributes
+    include CrystalApi::Attributes
+  end
+end

data/spec/crystal_api/category_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe CrystalApi::Category do
+  describe ".from_json" do
+    let(:json_hash) {{
+      "category" => {
+        "id" => 321,
+        "catalog_id" => 1,
+        "name" => "Return to Ravnica Block",
+        "seoname" => "return_to_ravnica_block",
+        "is_root" => false,
+        "is_visible_for_buying" => false,
+        "is_visible_for_selling" => true,
+        "description" => "describe this!",
+        "is_leaf" => false,
+        "browse_layout" => "Hybrid4x1",
+        "photos" => [],
+        "buylist_links" => {
+          "en" => {
+            "href" => "http://www.example.com/buylist/return_to_ravnica_block/321"
+          }
+        },
+        "catalog_links" => {
+          "en" => {
+            "href" => "http://www.example.com/catalog/return_to_ravnica_block/321"
+          }
+        },
+        "_links" => {
+          "self" => { "href" => "/v1/categories/321" },
+          "products" => { "href" => "/v1/categories/321/products" },
+          "children" => { "href" => "/v1/categories/321/children" },
+          "tree" => { "href" => "/v1/categories/321/tree" },
+          "parent_category" => { "href" => "/v1/categories/8" }
+        },
+        "descriptors" => [
+          {
+            "descriptor" => {
+              "is_enable_filter" => true,
+              "name" => "Card Type",
+              "options" => []
+            }
+          },
+          {
+            "descriptor" => {
+              "is_enable_filter" => true,
+              "name" => "Color",
+              "options" => [
+                "Artifact",
+                "Black",
+                "Blue",
+                "Green",
+                "Land",
+                "Multi-Color",
+                "Red",
+                "White",
+                "Colorless"
+              ]
+            }
+          }
+        ],
+        "_embedded" => {
+          "ancestors" => [
+            { "category" => { "name" => "My Store" } },
+            { "category" => { "name" => "Magic Singles!" } }
+          ]
+        }
+      }
+    }}
+
+    subject { CrystalApi::Category.from_json(json_hash) }
+
+    its(:id) { should == 321 }
+    its(:catalog_id) { should == 1 }
+    its(:name) { should == "Return to Ravnica Block" }
+    its(:seoname) { should == "return_to_ravnica_block" }
+
+    its(:is_root) { should == false }
+    its(:root?) { should == false }
+
+    its(:is_leaf) { should == false }
+    its(:leaf?) { should == false }
+
+    its(:is_visible_for_buying) { should == false }
+    its(:visible_for_buying?) { should == false }
+
+    its(:is_visible_for_selling) { should == true }
+    its(:visible_for_selling?) { should == true }
+
+    its(:description) { should == "describe this!" }
+    its(:browse_layout) { should == "Hybrid4x1" }
+
+    its(:catalog_links) { should == {
+      "en" => CrystalApi::Url.new(href: "http://www.example.com/catalog/return_to_ravnica_block/321")
+    }}
+
+    its(:buylist_links) { should == {
+      "en" => CrystalApi::Url.new(href: "http://www.example.com/buylist/return_to_ravnica_block/321")
+    }}
+
+    its(:descriptors) { should == [
+      CrystalApi::Descriptor.new(is_enable_filter: true, name: "Card Type", options: []),
+      CrystalApi::Descriptor.new(is_enable_filter: true, name: "Color", options: [
+        "Artifact", "Black", "Blue", "Green", "Land", "Multi-Color", "Red",
+        "White", "Colorless"])
+    ] }
+
+    its(:ancestors) { should == [
+      CrystalApi::Category.new(name: "My Store"),
+      CrystalApi::Category.new(name: "Magic Singles!")
+    ]}
+  end
+end

data/spec/crystal_api/money_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe CrystalApi::Money do
+  describe ".from_json" do
+    it "parses the json" do
+      CrystalApi::Money.from_json({"money" => {"cents" => 500, "currency" => "USD"}}).
+        should == Money.new(500, "USD")
+    end
+  end
+end

data/spec/crystal_api/paginated_collection_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe CrystalApi::PaginatedCollection do
+  describe ".from_json" do
+    let(:json_hash) {{
+      "paginated_collection" => {
+        "total_entries" => 33061,
+        "total_pages" => 331,
+        "previous_page" => nil,
+        "_links" => {
+          "self" => {
+            "href" => "/v1/products"
+          },
+          "next_page" => {
+            "href" => "/v1/products?page=2"
+          }
+        },
+        "next_page" => 2,
+        "entries" => [{"product" => {"name" => "Lotus Cobra"}}]
+      }
+    }}
+
+    subject { CrystalApi::PaginatedCollection.from_json(json_hash) }
+
+    its(:total_entries) { should == 33061 }
+    its(:total_pages) { should == 331 }
+    its(:previous_page) { should == nil }
+    its(:next_page) { should == 2}
+    its(:entries) { should == [CrystalApi::Product.new(name: "Lotus Cobra")] }
+  end
+end