Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 2.87 KB

README.mkd

File metadata and controls

85 lines (52 loc) · 2.87 KB
Raw

The Big Cartel Ruby Gem

A Ruby wrapper for the Big Cartel External REST API.

Build Status

Version 1.0.5

With the release of 1.0 I changed some of the design of the gem and should be considered a breaking change if you were using the 0.* versions of the gem. I hope this new design of the gem will be faster and also more useful in your applications.

Installation

gem install bigcartel

Usage

require 'rubygems'
require 'bigcartel', '>~ 1.0.0'
require 'pp'


client = BigCartel::Client.new

client.store("tonkapark", {:show_products => true, :product_limit => 2})

client.products("tonkapark", {:limit => 100})

client.page("tonkapark", "page-permalink")


store = BigCartel.store("tonkapark")     

pp store.description

store.products.each do |product|
 pp product.name
 pp product.image.thumb
end

What you can do with the gem

As part of the Big Cartel Themes and Templates available from Tonka Park there was a small web app built using the BigCartel gem to generate google products xml and also create a theme preview.

See the gem in action at http://carteltools.heroku.com

Supported Rubies

  • 1.8.7
  • 1.9.2

Change Log

1.0.5 - January 12, 2003

  • Big Cartel changed url for their images again.

1.0.4 - January 12, 2003

  • fixed bug in regexp that broke images call when Big Cartel changed url for their images.

1.0.0 - November 17, 2011

  • redesigned wrapper from the ground up
  • added rspec tests
  • support for ruby 1.9.2 and 1.8.7

Copyright

Copyright (c) 2011 Matt Anderson, Tonka Park

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.