nimbu-api 0.1.1 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fe69fea88b50f988c783136e7c5be19e292f47d
+  data.tar.gz: ef2bf03366e0a6fe07b83cf5425d57b93786e0ae
+SHA512:
+  metadata.gz: 4f90a9016cabb405549fd2772d589d41c8d49083bb454ad78884feace8782586e62f3f2b35bd155c55f16c8e925600b919c34c56a05f02b85eb7d0b6d04507a0
+  data.tar.gz: 3346bb86971830621b67428e2b124c0799e0d0a150c3b6d012b58c4c5e06be2336fa37dfb8cec91d10db5cb4429c0a2dbe7b051c3872d19ade36bcb68350e40e

data/README.md

@@ -1,29 +1,105 @@
-# Nimbu
+# NimbuAPI
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/nimbu-api.png)](http://badge.fury.io/rb/nimbu-api)
+
+A Ruby wrapper for the Nimbu API.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem by issuing
 
-    gem 'nimbu'
+```ruby
+gem install nimbu-api
+```
 
-And then execute:
+or put it in your Gemfile and run `bundle install`
 
-    $ bundle
+```ruby
+gem "nimbu-api"
+```
 
-Or install it yourself as:
+## Usage
 
-    $ gem install nimbu
+To use the gem, create a new client instance
 
-## Usage
+```ruby
+nimbu = Nimbu.new
+```
+
+You can supply following configuration parameters, such as
+```
+  auto_pagination  # by default false, set to true traverses requests page links
+  oauth_token      # oauth authorization token
+  basic_auth       # login:password string
+  client_id        # oauth client id
+  client_secret    # oauth client secret
+  subdomain        # the nimbu administration subdomain used in requets if none provided
+  endpoint         # nimbu enterprise api endpoint
+  site             # nimbu enterprise api web endpoint
+  ssl              # ssl settings
+  per_page         # number of items per page, max 100
+  user_agent       # custom user agent name, by default 'Nimbu Ruby Client'
+```
+which are used throughout the API. These can be passed directly as hash options:
+
+```ruby
+nimbu = Nimbu.new oauth_token: 'token'
+```
+
+Alternatively, you can configure the Nimbu settings by passing a block, for instance, with custom enterprise endpoint and website like
+
+```ruby
+nimbu = Nimbu.new do |config|
+  config.endpoint    = 'https://api.company.com'
+  config.site        = 'https://www.company.com'
+  config.oauth_token = 'token'
+  config.ssl         = {:verify => false}
+end
+```
+
+You can authenticate either using OAuth authentication or through basic authentication by passing your login and password:
+
+```ruby
+nimbu = Nimbu.new login:'peter', password:'...'
+```
+
+or use following convenience method:
+
+```ruby
+nimbu = Nimbu.new basic_auth: 'login:password'
+```
+
+This gem follows the Nimbu API hierarchy. This means, i.e. if you want to create a new entry for a given channel,
+you can lookup the nimbu api spec and parse the request as in `nimbu.channels(channel_id: 'mychannel').entries.create`
+
+The response is always of type [Hashie::Mash] and allows to traverse all the json response attributes like method calls i.e.
+
+```ruby
+entries = Nimbu::Channel::Entries.new :oauth_token => '...', :subdomain => '...', :channel_id => '...'
+entries.all do |entry|
+  puts entry.title
+end
+```
+
+## Arguments & Parameters
+
+The library allows for flexible arguments parsing. This means arguments can be passed during instance creation:
+
+```ruby
+  channel = Nimbu::Channel.new :oauth_token => '...', :subdomain => '...', :channel_id => '...'
+  channel.entries.list state: 'public'
+```
+
+Further, arguments can be passed directly inside method called but then the order of parameters matters and hence please consult the method documentation or Nimbu specification. For instance:
 
-TODO: Write usage instructions here
+```ruby
+  channel = Nimbu::Channel.new :oauth_token => '...', :subdomain => '...'
+  channel.entries.list channel_id: '...', state: 'public'
+```
 
-## Contributing
+Similarly, the arguments for the request can be passed inside the current scope such as:
 
-1. Fork it
-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 new Pull Request
+```ruby
+  channel = Nimbu::Channel.new :oauth_token => '...', :subdomain => '...'
+  channel.entries(channel_id: '...').list(state: 'public')
+```

data/lib/nimbu-api/configuration.rb

@@ -52,7 +52,7 @@ module Nimbu
     DEFAULT_SSL = {}
 
     # The value sent in the http header for 'User-Agent' if none is set
-    DEFAULT_USER_AGENT = "Nimbu Ruby Client #{Nimbu::API::VERSION}".freeze
+    DEFAULT_USER_AGENT = "nimbu-api/#{Nimbu::API::VERSION} (#{RUBY_PLATFORM}) ruby/#{RUBY_VERSION}".freeze
 
     # By default the <tt>Accept</tt> header will make a request for <tt>JSON</tt>
     DEFAULT_MIME_TYPE = :json

data/lib/nimbu-api/connection.rb

@@ -74,7 +74,7 @@ module Nimbu
     # Returns a Fraday::Connection object
     #
     def connection(options={})
-      conn_options = default_options(options)
+      conn_options = default_options({ :ssl => { :ca_file => File.expand_path("../../../vendor/cacert.pem", __FILE__) } }.merge(options))
       clear_cache unless options.empty?
       puts "OPTIONS:#{conn_options.inspect}" if ENV['DEBUG']
 

data/lib/nimbu-api/version.rb

@@ -1,5 +1,5 @@
 module Nimbu
   module API
-    VERSION = "0.1.1"
+    VERSION = "0.1.3"
   end
 end