xplenty-api 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Xplenty rb is a Ruby artifact that provides a simple wrapper for the [Xplenty REST Api](https://github.com/xplenty/xplenty-api-doc).
7
7
  To use it, create an Xplenty::API object and call its methods to access the Xplenty API.
8
- This page describes the available XplentyAPI methods.
8
+ This page describes the available Xplenty::API methods.
9
9
 
10
10
  ### Create an Xplenty::API Object
11
11
 
@@ -13,6 +13,8 @@ Pass your account ID and API key to the XplentyAPI constructor.
13
13
  ```ruby
14
14
  @xplenty = Xplenty::API.new(:api_key => 'your_api_key', :account_id => 'your_account_id')
15
15
  ```
16
+ NOTE: You can leave out :api_key or :account_id if ENV['XPLENTY_API_KEY'] or ENV['XPLENTY_ACCOUNT_ID'] is set accordingly instead.
17
+
16
18
  If you want to supply custom values for the version, scheme or host that the Xplenty::API object will use,
17
19
  you can use Xplenty::API builder methods to customize these properties.
18
20
  ```ruby
@@ -26,7 +26,8 @@ module Xplenty
26
26
  class API
27
27
 
28
28
  HEADERS = {
29
- 'Accept' => 'application/vnd.xplenty+json'
29
+ 'Accept' => 'application/vnd.xplenty+json',
30
+ 'User-Agent' => "xplenty-rb/#{Xplenty::API::VERSION}",
30
31
  }
31
32
 
32
33
  OPTIONS = {
@@ -1,5 +1,5 @@
1
1
  module Xplenty
2
2
  class API
3
- VERSION = "0.1.0"
3
+ VERSION = "0.1.1"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: xplenty-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -10,7 +10,7 @@ authors:
10
10
  autorequire:
11
11
  bindir: bin
12
12
  cert_chain: []
13
- date: 2013-05-14 00:00:00.000000000 Z
13
+ date: 2013-05-16 00:00:00.000000000 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: excon