Sha256: 4e44895c97244e13dd7fd1eff942a54f617aec25599f90661d5b3fb4edc54368

Contents?: true

Size: 1.8 KB

Versions: 6

Compression:

Stored size: 1.8 KB

Contents

# Fifthgear
[![Build Status](https://travis-ci.org/WalkerAndCoBrandsInc/fifthgear.svg?branch=develop)](https://travis-ci.org/WalkerAndCoBrandsInc/fifthgear) [![Code Climate](https://codeclimate.com/github/WalkerAndCoBrandsInc/fifthgear/badges/gpa.svg)](https://codeclimate.com/github/WalkerAndCoBrandsInc/fifthgear) [![Test Coverage](https://codeclimate.com/github/WalkerAndCoBrandsInc/fifthgear/badges/coverage.svg)](https://codeclimate.com/github/WalkerAndCoBrandsInc/fifthgear)

Ruby gem for interfacing with [Fifthgear's](https://github.com/fifthgear/fifthgear-raw) api

## Installation

Add this line to your application's Gemfile:

    gem 'fifthgear'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install fifthgear

## Usage

### Configuration
```ruby
Fifthgear.configure do |config|
  config.api_root = 'https://commerceservicestest.infifthgear.com'
  config.api_version = '/v2.0/CommerceServices.svc/Rest'
  config.username = 'foo'
  config.password = 'bar'
  config.company_id = 'big_time_biz_1234'
  config.content_type = 'application/json'
  config.debug = true
end
```

### Helpers

Fifthgear requires dates to be in a specific format. We've added a helper function for formatting the dates correctly.
Internally it uses [Chronic](https://github.com/mojombo/chronic) to parse the date.
```ruby
irb(main):001:0>  Fifthgear::Helper.format_date('12/01/2014')
=> "Date(1417464000000-0800)"
irb(main):002:0>  Fifthgear::Helper.format_date('12/01/2014 12:12:12')
=> "Date(1417464732000-0800)"
irb(main):003:0>
```

## Contributing

1. Fork it ( https://github.com/WalkerAndCoBrandsInc/fifthgear/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
fifthgear-0.0.8 README.md
fifthgear-0.0.7 README.md
fifthgear-0.0.6 README.md
fifthgear-0.0.5 README.md
fifthgear-0.0.3 README.md
fifthgear-0.0.2 README.md