buffer-alpaca 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67a71d02204a85ab67796f39465df7628d02e7d6
+  data.tar.gz: c4e047efefc8c69f41de9c502e3a4de81521cd66
+SHA512:
+  metadata.gz: 2d342b22c399737ea55a58d93e41d276f9a9a1b68939e21a10341ce0cf80651687ae2540d71a3ce4fbf272222a9958aa2e604bb5dfcdd08c97a24905a4ccd803
+  data.tar.gz: d3e5ac5808c6557e3f4cec31e215d7ee13fa2400fef87bdf75ac2548ee64dfaa902fd999c2ff30164c0a95be94577f13eb18e26e3771087b04ab3d177cf1808c

data/lib/buffer/api/info.rb

@@ -0,0 +1,28 @@
+module Buffer
+
+  module Api
+
+    # Returns api instance to get auxilary information about Buffer useful when creating your app.
+    #
+    class Info
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns an object with the current configuration that Buffer is using, including supported services, their icons and the varying limits of character and schedules.
+      # '/info/configuration' GET
+      #
+      def show(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/info/configuration", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/api/link.rb

@@ -0,0 +1,30 @@
+module Buffer
+
+  module Api
+
+    # Returns api instance to get information about links shared through Buffer.
+    #
+    class Link
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns an object with a the numbers of shares a link has had using Buffer.
+      # '/link/shares' GET
+      #
+      # url - URL of the page for which the number of shares is requested.
+      def shares(url, options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+        body[:url] = url
+
+        response = @client.get "/link/shares", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/api/profile.rb

@@ -0,0 +1,76 @@
+module Buffer
+
+  module Api
+
+    # Returns a social media profile api instance.
+    #
+    # id - Identifier of a social media profile
+    class Profile
+
+      def initialize(id, client)
+        @id = id
+        @client = client
+      end
+
+      # Returns details of the single specified social media profile.
+      # '/profiles/:id' GET
+      #
+      def show(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/profiles/#{@id}", body, options
+
+        return response
+      end
+
+      # Returns an array of updates that are currently in the buffer for an individual social media profile.
+      # '/profiles/:id/updates/pending' GET
+      #
+      def pending(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/profiles/#{@id}/updates/pending", body, options
+
+        return response
+      end
+
+      # Returns an array of updates that have been sent from the buffer for an individual social media profile.
+      # '/profiles/:id/updates/sent' GET
+      #
+      def sent(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/profiles/#{@id}/updates/sent", body, options
+
+        return response
+      end
+
+      # Edit the order at which statuses for the specified social media profile will be sent out of the buffer.
+      # '/profiles/:id/updates/reorder' POST
+      #
+      # order - An ordered array of status update id's. This can be a partial array in combination with the offset parameter or a full array of every update in the profiles Buffer.
+      def reorder(order, options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:order] = order
+
+        response = @client.post "/profiles/#{@id}/updates/reorder", body, options
+
+        return response
+      end
+
+      # Randomize the order at which statuses for the specified social media profile will be sent out of the buffer.
+      # '/profiles/:id/updates/shuffle' POST
+      #
+      def shuffle(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.post "/profiles/#{@id}/updates/shuffle", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/api/schedule.rb

@@ -0,0 +1,43 @@
+module Buffer
+
+  module Api
+
+    # Returns scheduling api instance for social media profile.
+    #
+    # id - Identifier of a social media profile
+    class Schedule
+
+      def initialize(id, client)
+        @id = id
+        @client = client
+      end
+
+      # Returns details of the posting schedules associated with a social media profile.
+      # '/profiles/:id/schedules' GET
+      #
+      def list(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/profiles/#{@id}/schedules", body, options
+
+        return response
+      end
+
+      # Set the posting schedules for the specified social media profile.
+      # '/profiles/:id/schedules/update' POST
+      #
+      # schedules - Each item in the array is an individual posting schedule which consists of days and times to match the format return by the above method.
+      def update(schedules, options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:schedules] = schedules
+
+        response = @client.post "/profiles/#{@id}/schedules/update", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/api/update.rb

@@ -0,0 +1,87 @@
+module Buffer
+
+  module Api
+
+    # Returns a social media update api instance.
+    #
+    # id - Identifier of a social media update
+    class Update
+
+      def initialize(id, client)
+        @id = id
+        @client = client
+      end
+
+      # Returns a single social media update.
+      # '/updates/:id' GET
+      #
+      def show(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/updates/#{@id}", body, options
+
+        return response
+      end
+
+      # Returns the detailed information on individual interactions with the social media update such as favorites, retweets and likes.
+      # '/updates/:id/interactions' GET
+      #
+      def interactions(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/updates/#{@id}/interactions", body, options
+
+        return response
+      end
+
+      # Edit an existing, individual status update.
+      # '/updates/:id/update' POST
+      #
+      # text - The status update text.
+      def update(text, options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:text] = text
+
+        response = @client.post "/updates/#{@id}/update", body, options
+
+        return response
+      end
+
+      # Immediately shares a single pending update and recalculates times for updates remaining in the queue.
+      # '/updates/:id/share' POST
+      #
+      def share(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.post "/updates/#{@id}/share", body, options
+
+        return response
+      end
+
+      # Permanently delete an existing status update.
+      # '/updates/:id/destroy' POST
+      #
+      def destroy(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.post "/updates/#{@id}/destroy", body, options
+
+        return response
+      end
+
+      # Move an existing status update to the top of the queue and recalculate times for all updates in the queue. Returns the update with its new posting time.
+      # '/updates/:id/move_to_top' POST
+      #
+      def top(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.post "/updates/#{@id}/move_to_top", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/api/user.rb

@@ -0,0 +1,54 @@
+module Buffer
+
+  module Api
+
+    # Returns authenticated user api instance.
+    #
+    class User
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns information about the authenticated user.
+      # '/user' GET
+      #
+      def show(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/user", body, options
+
+        return response
+      end
+
+      # Returns an array of social media profiles connected to the authenticated users account.
+      # '/profiles' GET
+      #
+      def profiles(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/profiles", body, options
+
+        return response
+      end
+
+      # Create one or more new status updates.
+      # '/updates/create' POST
+      #
+      # text - The status update text.
+      # profile_ids - An array of profile id's that the status update should be sent to. Invalid profile_id's will be silently ignored.
+      def create_update(text, profile_ids, options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:text] = text
+        body[:profile_ids] = profile_ids
+
+        response = @client.post "/updates/create", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/client.rb

@@ -0,0 +1,60 @@
+require "faraday"
+require "json"
+
+require "buffer/api/info"
+require "buffer/api/user"
+require "buffer/api/link"
+require "buffer/api/profile"
+require "buffer/api/schedule"
+require "buffer/api/update"
+
+module Buffer
+
+  class Client
+
+    def initialize(auth = {}, options = {})
+      @http_client = Buffer::HttpClient::HttpClient.new auth, options
+    end
+
+    # Returns api instance to get auxilary information about Buffer useful when creating your app.
+    #
+    def info()
+      Buffer::Api::Info.new @http_client
+    end
+
+    # Returns authenticated user api instance.
+    #
+    def user()
+      Buffer::Api::User.new @http_client
+    end
+
+    # Returns api instance to get information about links shared through Buffer.
+    #
+    def link()
+      Buffer::Api::Link.new @http_client
+    end
+
+    # Returns a social media profile api instance.
+    #
+    # id - Identifier of a social media profile
+    def profile(id)
+      Buffer::Api::Profile.new id, @http_client
+    end
+
+    # Returns scheduling api instance for social media profile.
+    #
+    # id - Identifier of a social media profile
+    def schedule(id)
+      Buffer::Api::Schedule.new id, @http_client
+    end
+
+    # Returns a social media update api instance.
+    #
+    # id - Identifier of a social media update
+    def update(id)
+      Buffer::Api::Update.new id, @http_client
+    end
+
+  end
+
+end

data/lib/buffer/error/client_error.rb

@@ -0,0 +1,18 @@
+module Buffer
+
+  module Error
+
+    class ClientError < ::StandardError
+
+      attr_reader :code
+
+      def initialize(message, code)
+        @code = code
+        super message
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/error.rb

@@ -0,0 +1,9 @@
+require "buffer/error/client_error"
+
+module Buffer
+
+  module Error
+
+  end
+
+end

data/lib/buffer/http_client/auth_handler.rb

@@ -0,0 +1,91 @@
+require "base64"
+
+module Buffer
+
+  module HttpClient
+
+    # AuthHandler takes care of devising the auth type and using it
+    class AuthHandler < Faraday::Middleware
+
+      URL_SECRET = 2
+      URL_TOKEN = 3
+
+      def initialize(app, auth = {}, options = {})
+        @auth = auth
+        super(app)
+      end
+
+      def call(env)
+        if !@auth.empty?
+          auth = get_auth_type
+          flag = false
+
+          if auth == URL_SECRET
+            env = url_secret env
+            flag = true
+          end
+
+          if auth == URL_TOKEN
+            env = url_token env
+            flag = true
+          end
+
+          if !flag
+            raise StandardError.new "Unable to calculate authorization method. Please check"
+          end
+        end
+
+        @app.call(env)
+      end
+
+      # Calculating the Authentication Type
+      def get_auth_type()
+
+        if @auth.has_key?(:client_id) and @auth.has_key?(:client_secret)
+          return URL_SECRET
+        end
+
+        if @auth.has_key?(:access_token)
+          return URL_TOKEN
+        end
+
+        return -1
+      end
+
+      # OAUTH2 Authorization with client secret
+      def url_secret(env)
+        query = {
+          :client_id => @auth[:client_id],
+          :client_secret => @auth[:client_secret]
+        }
+
+        merge_query env, query
+      end
+
+      # OAUTH2 Authorization with access token
+      def url_token(env)
+        query = { :access_token => @auth[:access_token] }
+
+        merge_query env, query
+      end
+
+      def query_params(url)
+        if url.query.nil? or url.query.empty?
+          {}
+        else
+          Faraday::Utils.parse_query url.query
+        end
+      end
+
+      def merge_query(env, query)
+        query = query.update query_params(env[:url])
+
+        env[:url].query = Faraday::Utils.build_query query
+
+        return env
+      end
+    end
+
+  end
+
+end

data/lib/buffer/http_client/error_handler.rb

@@ -0,0 +1,51 @@
+module Buffer
+
+  module HttpClient
+
+    # ErrorHanlder takes care of selecting the error message from response body
+    class ErrorHandler < Faraday::Middleware
+
+      def initialize(app)
+        super(app)
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |env|
+          code = env[:response].status
+          type = env[:response].headers["content-type"]
+
+          case code
+          when 500...599
+            raise Buffer::Error::ClientError.new "Error #{code}", code
+          when 400...499
+            body = Buffer::HttpClient::ResponseHandler.get_body env[:response]
+            message = ""
+
+            # If HTML, whole body is taken
+            if body.is_a? String
+              message = body
+            end
+
+            # If JSON, a particular field is taken and used
+            if type.include?("json") and body.is_a?(Hash)
+              if body.has_key? "error"
+                message = body["error"]
+              else
+                message = "Unable to select error message from json returned by request responsible for error"
+              end
+            end
+
+            if message == ""
+              message = "Unable to understand the content type of response returned by request responsible for error"
+            end
+
+            raise Buffer::Error::ClientError.new message, code
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/http_client/request_handler.rb

@@ -0,0 +1,30 @@
+module Buffer
+
+  module HttpClient
+
+    # RequestHandler takes care of encoding the request body into format given by options
+    class RequestHandler
+
+      def self.set_body(options)
+        type = options.has_key?(:request_type) ? options[:request_type] : "form"
+
+        # Encoding body into form-urlencoded format
+        if type == "form"
+          options[:body] = Faraday::Utils::ParamsHash[options[:body]].to_query
+          options[:headers]["content-type"] = "application/x-www-form-urlencoded"
+        end
+
+        # Raw body
+        if type == "raw"
+          options[:body] = options[:body].is_a?(Hash) ? "" : options[:body]
+          options[:headers].delete "content-type"
+        end
+
+        return options
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/http_client/response.rb

@@ -0,0 +1,20 @@
+module Buffer
+
+  module HttpClient
+
+    # Response object contains the response returned by the client
+    class Response
+
+      attr_accessor :body, :code, :headers
+
+      def initialize(body, code, headers)
+        @body = body
+        @code = code
+        @headers = headers
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/http_client/response_handler.rb

@@ -0,0 +1,24 @@
+module Buffer
+
+  module HttpClient
+
+    # ResponseHandler takes care of decoding the response body into suitable type
+    class ResponseHandler
+
+      def self.get_body(response)
+        type = response.headers["content-type"]
+        body = response.body
+
+        # Response body is in JSON
+        if type.include? "json"
+          body = JSON.parse body
+        end
+
+        body
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer/http_client.rb

@@ -0,0 +1,129 @@
+require "buffer/http_client/auth_handler"
+require "buffer/http_client/error_handler"
+require "buffer/http_client/request_handler"
+require "buffer/http_client/response"
+require "buffer/http_client/response_handler"
+
+module Buffer
+
+  module HttpClient
+
+    # Main HttpClient which is used by Api classes
+    class HttpClient
+
+      attr_accessor :options, :headers
+
+      @headers = {}
+
+      def initialize(auth = {}, options = {})
+
+        if auth.is_a? String
+          auth = { :access_token => auth }
+        end
+
+        @options = {
+          :base => "https://api.bufferapp.com",
+          :api_version => "1",
+          :user_agent => "alpaca/0.1.0 (https://github.com/pksunkara/alpaca)"
+        }
+
+        @options.update options
+
+        @headers = {
+          "user-agent" => @options[:user_agent]
+        }
+
+        if @options.has_key? :headers
+          @headers.update Hash[@options[:headers].map { |k, v| [k.downcase, v] }]
+          @options.delete :headers
+        end
+
+        @client = Faraday.new @options[:base] do |conn|
+          conn.use Buffer::HttpClient::AuthHandler, auth
+          conn.use Buffer::HttpClient::ErrorHandler
+
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      def get(path, params = {}, options = {})
+        request path, nil, "get", options.merge({ :query => params })
+      end
+
+      def post(path, body = {}, options = {})
+        request path, body, "post", options
+      end
+
+      def patch(path, body = {}, options = {})
+        request path, body, "patch", options
+      end
+
+      def delete(path, body = {}, options = {})
+        request path, body, "delete", options
+      end
+
+      def put(path, body = {}, options = {})
+        request path, body, "put", options
+      end
+
+      # Intermediate function which does three main things
+      #
+      # - Transforms the body of request into correct format
+      # - Creates the requests with give parameters
+      # - Returns response body after parsing it into correct format
+      def request(path, body, method, options)
+        options = @options.merge options
+
+        options[:headers] = options[:headers] || {}
+        options[:headers] = @headers.merge Hash[options[:headers].map { |k, v| [k.downcase, v] }]
+
+        options[:body] = body
+
+        if method != "get"
+          options[:body] = options[:body] || {}
+          options = set_body options
+        end
+
+        response = create_request method, path, options
+
+        body = get_body response
+
+        Buffer::HttpClient::Response.new body, response.status, response.headers
+      end
+
+      # Creating a request with the given arguments
+      #
+      # If api_version is set, appends it immediately after host
+      def create_request(method, path, options)
+        version = options.has_key?(:api_version) ? "/#{options[:api_version]}" : ""
+
+        # Adds a suffix (ex: ".html", ".json") to url
+        suffix = options.has_key?(:response_type) ? options[:response_type] : "json"
+        path = "#{path}.#{suffix}"
+
+        path = "#{version}#{path}"
+
+        instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+          @client.#{method} path do |req|
+            req.body = options[:body]
+            req.headers.update(options[:headers])
+            req.params.update(options[:query]) if options[:query]
+          end
+        RUBY
+      end
+
+      # Get response body in correct format
+      def get_body(response)
+        Buffer::HttpClient::ResponseHandler.get_body response
+      end
+
+      # Set request body in correct format
+      def set_body(options)
+        Buffer::HttpClient::RequestHandler.set_body options
+      end
+
+    end
+
+  end
+
+end

data/lib/buffer-alpaca.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+
+require "buffer/client"
+require "buffer/error"
+require "buffer/http_client"
+
+module Buffer
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: buffer-alpaca
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavan Kumar Sunkara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+description: Buffer API library client for ruby
+email: pavan.sss1991@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/buffer-alpaca.rb
+- lib/buffer/api/info.rb
+- lib/buffer/api/link.rb
+- lib/buffer/api/profile.rb
+- lib/buffer/api/schedule.rb
+- lib/buffer/api/update.rb
+- lib/buffer/api/user.rb
+- lib/buffer/client.rb
+- lib/buffer/error.rb
+- lib/buffer/error/client_error.rb
+- lib/buffer/http_client.rb
+- lib/buffer/http_client/auth_handler.rb
+- lib/buffer/http_client/error_handler.rb
+- lib/buffer/http_client/request_handler.rb
+- lib/buffer/http_client/response.rb
+- lib/buffer/http_client/response_handler.rb
+homepage: https://bufferapp.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Buffer API library client for ruby
+test_files: []