nimbu-api 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nimbu.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peter Dedene
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Nimbu
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nimbu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nimbu
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nimbu-api.rb

@@ -0,0 +1,43 @@
+require "nimbu-api/version"
+
+require 'openssl'
+require 'faraday'
+require 'multi_json'
+
+require "nimbu-api/utils/all"
+require "nimbu-api/configuration"
+require "nimbu-api/connection"
+require 'nimbu-api/pagination'
+require 'nimbu-api/response'
+require 'nimbu-api/request'
+require 'nimbu-api/authentication'
+require 'nimbu-api/endpoint'
+require 'nimbu-api/client'
+
+require 'nimbu-api/endpoints/authorizations'
+require 'nimbu-api/endpoints/sites'
+require 'nimbu-api/endpoints/channels'
+require 'nimbu-api/endpoints/channels/entries'
+require 'nimbu-api/endpoints/videos'
+
+module Nimbu
+  extend Configuration
+
+  class << self
+    def new(options = {}, &block)
+      Nimbu::Client.new(options, &block)
+    end
+
+    # Delegate to Nimbu::Client
+    #
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+  end
+end # Nimbu

data/lib/nimbu-api/authentication.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+module Nimbu
+  module Authentication
+
+    attr_accessor :scopes
+
+    # Setup OAuth2 instance
+    def client(options={})
+      @client ||= ::OAuth2::Client.new(client_id, client_secret,
+        {
+          :site          => options.fetch(:site) { Nimbu.site },
+          :authorize_url => 'login/oauth/authorize',
+          :token_url     => 'login/oauth/access_token',
+          :ssl           => { :verify => false }
+        }
+      )
+    end
+
+    # Strategy token
+    def auth_code
+      _verify_client
+      client.auth_code
+    end
+
+    # Sends authorization request to Nimbu.
+    # = Parameters
+    # * <tt>:redirect_uri</tt> - Required string.
+    # * <tt>:scope</tt> - Optional string. Comma separated list of scopes.
+    #   Available scopes:
+    #   * (no scope) - public read-only access (includes public user profile info, public repo info, and gists).
+    #   * <tt>user</tt> - DB read/write access to profile info only.
+    #   * <tt>public_repo</tt> - DB read/write access, and Git read access to public repos.
+    #   * <tt>repo</tt> - DB read/write access, and Git read access to public and private repos.
+    #   * <tt>gist</tt> - write access to gists.
+    #
+    def authorize_url(params = {})
+      _verify_client
+      client.auth_code.authorize_url(params)
+    end
+
+    # Makes request to token endpoint and retrieves access token value
+    def get_token(authorization_code, params = {})
+      _verify_client
+      client.auth_code.get_token(authorization_code, params)
+    end
+
+    # Check whether authentication credentials are present
+    def authenticated?
+      basic_authed? || oauth_token?
+    end
+
+    # Check whether basic authentication credentials are present
+    def basic_authed?
+      basic_auth? || (login? && password?)
+    end
+
+    # Select authentication parameters
+    def authentication
+      if basic_auth?
+        { :basic_auth => basic_auth }
+      elsif login? && password?
+        { :login => login, :password => password }
+      else
+        { }
+      end
+    end
+
+    private
+
+    def _verify_client # :nodoc:
+      raise ArgumentError, 'Need to provide client_id and client_secret' unless client_id? && client_secret?
+    end
+
+  end # Authorization
+end # Nimbu

data/lib/nimbu-api/builder.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'nimbu-api/utils/all'
+
+module Nimbu
+  class Builder
+
+    # Instantiates a new Nimbu api object
+    #
+    def self.new(klass, options={}, &block)
+      return create_instance(klass, options, &block) if klass
+      raise ArgumentError, 'must provide Endpoint class to be instantiated'
+    end
+
+    # Passes configuration options to instantiated class
+    #
+    def self.create_instance(klass, options, &block)
+      options.symbolize_keys!
+      convert_to_constant(klass.to_s).new options, &block
+    end
+
+    # Convert name to constant
+    #
+    def self.convert_to_constant(classes)
+      classes.split('::').inject(Nimbu::Endpoints) do |constant, klass|
+        constant.const_get klass
+      end
+    end
+
+  end # Builder
+end # Nimbu

data/lib/nimbu-api/client.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'nimbu-api/builder'
+
+module Nimbu
+  class Client < Endpoint
+
+    def oauth(options={}, &block)
+      Nimbu::Builder.new('Authorizations', current_options.merge(options), &block)
+    end
+    alias :authorizations :oauth
+
+    def sites(options={}, &block)
+      Nimbu::Builder.new('Sites', current_options.merge(options), &block)
+    end
+
+    def channels(options={}, &block)
+      Nimbu::Builder.new('Channels', current_options.merge(options), &block)
+    end
+
+    def videos(options={}, &block)
+      Nimbu::Builder.new('Videos', current_options.merge(options), &block)
+    end
+
+  end # Client
+end # Nimbu

data/lib/nimbu-api/configuration.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+module Nimbu
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+      :client_id,
+      :client_secret,
+      :oauth_token,
+      :endpoint,
+      :site,
+      :ssl,
+      :mime_type,
+      :user_agent,
+      :connection_options,
+      :login,
+      :password,
+      :basic_auth,
+      :auto_pagination,
+      :adapter
+    ].freeze
+
+    # By default, don't set an application key
+    DEFAULT_CLIENT_ID = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CLIENT_SECRET = nil
+
+    # By default, don't set a user oauth access token
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # By default, don't set a user login name
+    DEFAULT_LOGIN = nil
+
+    # By default, don't set a user password
+    DEFAULT_PASSWORD = nil
+
+    # By default, don't set a user basic authentication
+    DEFAULT_BASIC_AUTH = nil
+
+    # The api endpoint used to connect to Nimbu if none is set
+    DEFAULT_ENDPOINT = 'https://api.nimbu.io'.freeze
+
+    # The web endpoint used to connect to Nimbu if none is set
+    DEFAULT_SITE = 'https://www.nimbu.io'.freeze
+
+    # The default SSL configuration
+    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
+
+    # By default the <tt>Accept</tt> header will make a request for <tt>JSON</tt>
+    DEFAULT_MIME_TYPE = :json
+
+    # By default uses the Faraday connection options if none is set
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # By default, don't traverse the page links
+    DEFAULT_AUTO_PAGINATION = false
+
+    # Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test
+    DEFAULT_ADAPTER = :net_http
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Convenience method to allow for global setting of configuration options
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.reset!
+    end
+
+    class << self
+      def keys
+        VALID_OPTIONS_KEYS
+      end
+    end
+
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
+      options
+    end
+
+    # Reset configuration options to their defaults
+    #
+    def reset!
+      self.client_id          = DEFAULT_CLIENT_ID
+      self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.site               = DEFAULT_SITE
+      self.ssl                = DEFAULT_SSL
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.mime_type          = DEFAULT_MIME_TYPE
+      self.login              = DEFAULT_LOGIN
+      self.password           = DEFAULT_PASSWORD
+      self.basic_auth         = DEFAULT_BASIC_AUTH
+      self.auto_pagination    = DEFAULT_AUTO_PAGINATION
+      self.adapter            = DEFAULT_ADAPTER
+      self
+    end
+
+  end # Configuration
+end # Nimbu

data/lib/nimbu-api/connection.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+module Nimbu
+  module Connection
+    extend self
+    include Nimbu::Utils::Constants
+
+    ALLOWED_OPTIONS = [
+      :headers,
+      :url,
+      :params,
+      :request,
+      :ssl
+    ].freeze
+
+    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 }
+      }.merge(options)
+    end
+
+    # Default middleware stack that uses default adapter as specified at
+    # configuration stage.
+    #
+    def default_middleware(options={})
+      Proc.new do |builder|
+        unless options[:with_attachments]
+          builder.use Nimbu::Request::Json
+        end
+        builder.use Faraday::Request::Multipart
+        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 Faraday::Response::Logger if ENV['DEBUG']
+        unless options[:raw]
+          builder.use Nimbu::Response::Mashify
+          builder.use Nimbu::Response::Json
+        end
+        builder.use Nimbu::Response::RaiseError
+        builder.adapter adapter
+      end
+    end
+
+    @connection = nil
+
+    @stack = nil
+
+    def clear_cache
+      @connection = nil
+    end
+
+    def caching?
+      !@connection.nil?
+    end
+
+    # Exposes middleware builder to facilitate custom stacks and easy
+    # addition of new extensions such as cache adapter.
+    #
+    def stack(options={}, &block)
+      @stack ||= begin
+        if block_given?
+          Faraday::Builder.new(&block)
+        else
+          Faraday::Builder.new(&default_middleware(options))
+        end
+      end
+    end
+
+    # Returns a Fraday::Connection object
+    #
+    def connection(options={})
+      conn_options = default_options(options)
+      clear_cache unless options.empty?
+      puts "OPTIONS:#{conn_options.inspect}" if ENV['DEBUG']
+
+      Faraday.new(conn_options.merge(:builder => stack(options)))
+    end
+
+  end # Connection
+end # Nimbu