nimbu-api 0.0.2 → 0.1

data/lib/nimbu-api.rb

@@ -1,6 +1,7 @@
 require "nimbu-api/version"
 
 require 'openssl'
+require 'excon'
 require 'faraday'
 require 'multi_json'
 
@@ -16,7 +17,9 @@ require 'nimbu-api/client'
 
 require 'nimbu-api/endpoints/authorizations'
 require 'nimbu-api/endpoints/login'
+require 'nimbu-api/endpoints/simulator'
 require 'nimbu-api/endpoints/sites'
+require 'nimbu-api/endpoints/themes'
 require 'nimbu-api/endpoints/channels'
 require 'nimbu-api/endpoints/channels/entries'
 require 'nimbu-api/endpoints/videos'

data/lib/nimbu-api/client.rb

@@ -14,6 +14,10 @@ module Nimbu
       Nimbu::Builder.new('Sites', current_options.merge(options), &block)
     end
 
+    def themes(options={}, &block)
+      Nimbu::Builder.new('Themes', current_options.merge(options), &block)
+    end
+
     def channels(options={}, &block)
       Nimbu::Builder.new('Channels', current_options.merge(options), &block)
     end
@@ -22,6 +26,10 @@ module Nimbu
       Nimbu::Builder.new('Videos', current_options.merge(options), &block)
     end
 
+    def simulator(options={}, &block)
+      Nimbu::Builder.new('Simulator', current_options.merge(options), &block)
+    end
+
     def authenticate(options={}, &block)
       Nimbu::Builder.new('Login', current_options.merge(options), &block).response
     end

data/lib/nimbu-api/configuration.rb

@@ -9,6 +9,7 @@ module Nimbu
       :oauth_token,
       :endpoint,
       :site,
+      :subdomain,
       :ssl,
       :mime_type,
       :user_agent,
@@ -38,6 +39,9 @@ module Nimbu
     # By default, don't set a user basic authentication
     DEFAULT_BASIC_AUTH = nil
 
+    # By default, don't set a nimbu subdomain
+    DEFAULT_SUBDOMAIN = nil
+
     # The api endpoint used to connect to Nimbu if none is set
     DEFAULT_ENDPOINT = 'https://api.nimbu.io'.freeze
 
@@ -48,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 Gem #{Nimbu::VERSION}".freeze
+    DEFAULT_USER_AGENT = "Nimbu Ruby Client #{Nimbu::API::VERSION}".freeze
 
     # By default the <tt>Accept</tt> header will make a request for <tt>JSON</tt>
     DEFAULT_MIME_TYPE = :json
@@ -102,6 +106,7 @@ module Nimbu
       self.basic_auth         = DEFAULT_BASIC_AUTH
       self.auto_pagination    = DEFAULT_AUTO_PAGINATION
       self.adapter            = DEFAULT_ADAPTER
+      self.subdomain          = DEFAULT_SUBDOMAIN
       self
     end
 

data/lib/nimbu-api/connection.rb

@@ -15,14 +15,9 @@ module Nimbu
 
     def default_options(options={})
       {
-        # :headers => {
-        #   # ACCEPT           => "application/json",
-        #   # ACCEPT_CHARSET   => "utf-8",
-        #   # USER_AGENT       => user_agent,
-        #   # CONTENT_TYPE     => 'application/json'
-        # },
         :ssl => options.fetch(:ssl) { ssl },
-        :url => options.fetch(:endpoint) { Nimbu.endpoint }
+        :url => options.fetch(:endpoint) { Nimbu.endpoint },
+        :subdomain => options.fetch(:subdomain) { Nimbu.subdomain }
       }.merge(options)
     end
 
@@ -38,13 +33,15 @@ module Nimbu
         builder.use Faraday::Request::UrlEncoded
         builder.use Nimbu::Request::OAuth2, oauth_token if oauth_token?
         builder.use Nimbu::Request::BasicAuth, authentication if basic_authed?
+        builder.use Nimbu::Request::UserAgent
+        builder.use Nimbu::Request::SiteHeader, subdomain
 
         builder.use Faraday::Response::Logger if ENV['DEBUG']
+        builder.use Nimbu::Response::RaiseError
         unless options[:raw]
           builder.use Nimbu::Response::Mashify
           builder.use Nimbu::Response::Json
         end
-        builder.use Nimbu::Response::RaiseError
         builder.adapter adapter
       end
     end

data/lib/nimbu-api/endpoints/channels.rb

@@ -6,7 +6,7 @@ module Nimbu
     class Channels < Endpoint
 
       def entries(options={}, &block)
-        @entries ||= Nimbu::Builder.new('Channels::Entries', current_options.merge(options), &block)
+        Nimbu::Builder.new('Channels::Entries', current_options.merge(options), &block)
       end
 
       def list(*args)

data/lib/nimbu-api/endpoints/simulator.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Nimbu
+  module Endpoints
+    class Simulator < Endpoint
+
+      def recipe(*args)
+        arguments(args)
+
+        response = post_request("/simulator/recipe", arguments.params)
+        return response
+      end
+
+      def render(*args)
+        arguments(args)
+
+        response = post_request("/simulator/render", arguments.params)
+        return response
+      end
+
+    end # Simulator
+  end # Endpoints
+end # Nimbu

data/lib/nimbu-api/endpoints/themes.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Nimbu
+  module Endpoints
+    class Themes < Endpoint
+
+      def list(*args)
+        arguments(args)
+
+        response = get_request("/themes", arguments.params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+      alias :all :list
+
+      def get(*args)
+        arguments(args, :required => [:theme_id])
+
+        get_request("/themes/#{theme_id}", arguments.params)
+      end
+      alias :find :get
+
+
+    end # Themes
+  end # Endpoints
+end # Nimbu

data/lib/nimbu-api/errors.rb

@@ -26,6 +26,6 @@ module Nimbu
   end # Error
 end # Nimbu
 
-%w( service_error bad_request unauthorized forbidden not_found not_acceptable unprocessable_entity internal_server_error service_unavailable client_error invalid_options required_params unknown_value validations ).each do |error|
+%w( service_error bad_request bad_gateway unauthorized forbidden not_found not_acceptable unprocessable_entity internal_server_error service_unavailable client_error invalid_options required_params unknown_value validations ).each do |error|
   require "nimbu-api/errors/#{error}"
 end

data/lib/nimbu-api/errors/bad_gateway.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Nimbu #:nodoc
+  # Raised when Nimbu returns the HTTP status code 502 (which 'should' never happen)
+  module Error
+    class BadGateway < ServiceError
+      http_status_code 502
+
+      def initialize(response)
+        super(response)
+      end
+
+    end # BadGateway
+  end # Error
+end # Nimbu

data/lib/nimbu-api/errors/service_error.rb

@@ -9,6 +9,7 @@ module Nimbu
       include ::Nimbu::Utils::Json
 
       attr_reader :http_headers
+      attr_reader :http_body
 
       def initialize(response)
         @http_headers = response[:response_headers]

data/lib/nimbu-api/request.rb

@@ -5,6 +5,8 @@ require 'nimbu-api/request/basic_auth'
 require 'nimbu-api/request/json'
 require 'nimbu-api/request/validations'
 require 'nimbu-api/request/arguments'
+require 'nimbu-api/request/user_agent'
+require 'nimbu-api/request/site_header'
 
 module Nimbu
 

data/lib/nimbu-api/request/site_header.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Nimbu
+  class Request::SiteHeader < Faraday::Middleware
+    include Nimbu::Utils::Constants
+
+    def call(env)
+      env[:request_headers].merge!(NIMBU_SITE => @subdomain) if @subdomain
+      @app.call env
+    end
+
+    def initialize(app, *args)
+      super app
+      @app = app
+      @subdomain = args.shift
+    end
+
+
+  end # Request::SiteHeader
+end # Nimbu

data/lib/nimbu-api/request/user_agent.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Nimbu
+  class Request::UserAgent < Faraday::Middleware
+    include Nimbu::Utils::Constants
+
+    def call(env)
+      env[:request_headers].merge!(USER_AGENT => Nimbu.user_agent)
+
+      @app.call env
+    end
+
+  end # Request::UserAgent
+end # Nimbu

data/lib/nimbu-api/utils/constants.rb

@@ -3,6 +3,12 @@ module Nimbu
     module Constants
       extend self
 
+      # Request headers
+      USER_AGENT = 'User-Agent'.freeze
+      ACCEPT = 'Accept'.freeze
+      ACCEPT_CHARSET = 'Accept-Charset'.freeze
+      NIMBU_SITE = 'X-Nimbu-Site'.freeze
+
       # Response headers
       RATELIMIT_REMAINING = 'X-RateLimit-Remaining'.freeze
       RATELIMIT_LIMIT = 'X-RateLimit-Limit'.freeze
@@ -13,9 +19,6 @@ module Nimbu
       SERVER = 'Server'.freeze
       DATE = 'Date'.freeze
       LOCATION = 'Location'.freeze
-      USER_AGENT = 'User-Agent'.freeze
-      ACCEPT = 'Accept'.freeze
-      ACCEPT_CHARSET = 'Accept-Charset'.freeze
       OAUTH_SCOPES = 'X-Oauth-Scopes'.freeze
       ACCEPTED_OAUTH_SCOPES = 'X-Accepted-Oauth-Scopes'.freeze
 

data/lib/nimbu-api/version.rb

@@ -1,3 +1,5 @@
 module Nimbu
-  VERSION = "0.0.2"
+  module API
+    VERSION = "0.1"
+  end
 end

data/nimbu-api.gemspec

@@ -5,7 +5,7 @@ require 'nimbu-api/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "nimbu-api"
-  gem.version       = Nimbu::VERSION
+  gem.version       = Nimbu::API::VERSION
   gem.authors       = ["Peter Dedene"]
   gem.email         = ["support@nimbu.io"]
   gem.summary       = 'Ruby bindings for the Nimbu API'
@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday'
   gem.add_dependency 'multi_json'
   gem.add_dependency 'oauth2'
+  gem.add_dependency 'excon'
 
   gem.add_development_dependency "bundler", "~> 1.3"
   gem.add_development_dependency "rake"

metadata

@@ -2,14 +2,14 @@
 name: nimbu-api
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.2
+  version: '0.1'
 platform: ruby
 authors:
 - Peter Dedene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -75,6 +75,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: excon
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -211,9 +227,12 @@ files:
 - lib/nimbu-api/endpoints/channels.rb
 - lib/nimbu-api/endpoints/channels/entries.rb
 - lib/nimbu-api/endpoints/login.rb
+- lib/nimbu-api/endpoints/simulator.rb
 - lib/nimbu-api/endpoints/sites.rb
+- lib/nimbu-api/endpoints/themes.rb
 - lib/nimbu-api/endpoints/videos.rb
 - lib/nimbu-api/errors.rb
+- lib/nimbu-api/errors/bad_gateway.rb
 - lib/nimbu-api/errors/bad_request.rb
 - lib/nimbu-api/errors/client_error.rb
 - lib/nimbu-api/errors/forbidden.rb
@@ -240,6 +259,8 @@ files:
 - lib/nimbu-api/request/normalizer.rb
 - lib/nimbu-api/request/oauth2.rb
 - lib/nimbu-api/request/parameter_filter.rb
+- lib/nimbu-api/request/site_header.rb
+- lib/nimbu-api/request/user_agent.rb
 - lib/nimbu-api/request/validations.rb
 - lib/nimbu-api/request/validations/format.rb
 - lib/nimbu-api/request/validations/presence.rb
@@ -275,7 +296,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 3347433547534944339
+      hash: -2620439181991597376
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
@@ -284,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 3347433547534944339
+      hash: -2620439181991597376
       version: '0'
 requirements: []
 rubyforge_project: