Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Made api more Ruby-like and fixed some bugs. #4

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Shopsense-Ruby - Ruby interface for the ShopStyle API
# Shopsense-Ruby - Ruby interface for the POPSUGAR Shopping API

The ShopStyle API, ShopSense! For Ruby! So Great.
The POPSUGAR Shopping API, ShopSense! For Ruby! So Great.

### Description

Expand All @@ -10,11 +10,14 @@ Shopsense-Ruby includes a set of convent classes and methods designed to make
accessing the [ShopStyle API](https://shopsense.shopstyle.com/page/ShopSenseHome)
from your Ruby application seamless.

## Installation
## Usage

Install the Ruby Gem:
Install with Bundler

$ gem install shopsense-ruby
Add the folowing to your Gemfile
```
gem "shopsense-ruby", :git => "git://github.com/PopSugar/ruby-popsugar-shopping-api.git", :branch => "master"
```

Include it in you Ruby application:

Expand All @@ -32,4 +35,4 @@ Please report any bugs found in Shopsense-Ruby [here](https://github.com/RudyCom

This gem looks to serve not only as a means of elegantly access the
[ShopStyle API](https://shopsense.shopstyle.com/page/ShopSenseHome)
but a means of offering a host of shopping oriented programing features!
but a means of offering a host of shopping oriented programing features!
2 changes: 1 addition & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ task :gh_pages do
`git push origin gh-pages`
end
end
=end
=end
13 changes: 6 additions & 7 deletions lib/shopsense.rb
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
require 'net/http'
require 'yajl'
require 'cgi'
=begin rdoc
Shopsense is an easy to use Ruby interface for the {Shopstyle API}[https://shopsense.shopstyle.com/page/ShopSenseHome],
also known a ShopSense. The ShopStyle API is a free service from ShopStyle that pays you for sending traffic
also known a ShopSense. The ShopStyle API is a free service from ShopStyle that pays you for sending traffic
to online retailers from your blog, website, or application.

The ShopStyle API allows client applications to retrieve the underlying data for all the basic elements of the
ShopStyle websites, including products, brands, retailers, categories, and looks. For ease of development,
the API is a REST-style web service, composed of simple HTTP GET requests. Data is returned to the client in
either XML or JSON formats. The API is client-language independent and easy to use from PHP, Java, JavaScript,
The ShopStyle API allows client applications to retrieve the underlying data for all the basic elements of the
ShopStyle websites, including products, brands, retailers, categories, and looks. For ease of development,
the API is a REST-style web service, composed of simple HTTP GET requests. Data is returned to the client in
either XML or JSON formats. The API is client-language independent and easy to use from PHP, Java, JavaScript,
or any other modern development context.

Shopsense provides a number of helpful classes and methods for integrating data aquired from the ShopStyle API into
Expand All @@ -20,5 +20,4 @@
see Shopsense::API
=end

require 'shopsense/client'
require 'shopsense/api'
Loading