ribose 0.1.0 → 0.2.0

data/bin/console

@@ -7,8 +7,5 @@ require "ribose"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/lib/ribose.rb

@@ -1,5 +1,35 @@
+require "faraday"
+require "sawyer"
+
 require "ribose/version"
+require "ribose/base"
+require "ribose/config"
+require "ribose/client"
+require "ribose/request"
+require "ribose/setting"
+require "ribose/space"
+require "ribose/app_data"
+require "ribose/app_relation"
+require "ribose/feed"
+require "ribose/widget"
+require "ribose/stream"
+require "ribose/leaderboard"
+require "ribose/connection"
+require "ribose/calendar"
+require "ribose/member"
+require "ribose/space_file"
+require "ribose/conversation"
+require "ribose/message"
+require "ribose/space_invitation"
+require "ribose/join_space_request"
+require "ribose/connection_invitation"
+require "ribose/user"
+require "ribose/session"
+require "ribose/profile"
+require "ribose/wiki"
 
 module Ribose
-  # Your code goes here...
+  def self.root
+    File.dirname(__dir__)
+  end
 end

data/lib/ribose/actions.rb

@@ -0,0 +1,10 @@
+require "ribose/actions/all"
+require "ribose/actions/fetch"
+require "ribose/actions/create"
+require "ribose/actions/update"
+require "ribose/actions/delete"
+
+module Ribose
+  module Actions
+  end
+end

data/lib/ribose/actions/all.rb

@@ -0,0 +1,43 @@
+require "ribose/actions/base"
+
+module Ribose
+  module Actions
+    module All
+      extend Ribose::Actions::Base
+      # List Resources
+      #
+      # Retrieve the list of resources via :get and then extract the
+      # the root element from the response object.
+      #
+      # @return [Array <Sawyer::Resource>]
+      #
+      def all
+        response = Ribose::Request.get(resources_path, custom_option)
+        extract_root(response) || response
+      end
+
+      private
+
+      def extract_root(response)
+        unless resources.nil?
+          response[resources]
+        end
+      end
+
+      module ClassMethods
+        # List Resources
+        #
+        # This exposes the instance method as class methods, and once
+        # invoked then it instantiate a new instance & invokes the all
+        # instance method with the provided parameters.
+        #
+        # @param options [Hash] Query parameters as Hash
+        # @return [Array <Sawyer::Resource>]
+        #
+        def all(options = {})
+          new(options).all
+        end
+      end
+    end
+  end
+end

data/lib/ribose/actions/base.rb

@@ -0,0 +1,11 @@
+require "ribose/request"
+
+module Ribose
+  module Actions
+    module Base
+      def included(base)
+        base.extend(const_get(:ClassMethods))
+      end
+    end
+  end
+end

data/lib/ribose/actions/create.rb

@@ -0,0 +1,44 @@
+require "ribose/actions/base"
+
+module Ribose
+  module Actions
+    module Create
+      extend Ribose::Actions::Base
+
+      def create
+        create_resource[resource]
+      end
+
+      private
+
+      # Attribute validations
+      #
+      # This method will be invoked by the create action to validate the
+      # attributes before submitting to the actual endpoint. We can override
+      # this one to validate user provider attributes.
+      #
+      def validate(attributes)
+        attributes
+      end
+
+      def request_body(attributes)
+        custom_option.merge(resource_key.to_sym => validate(attributes))
+      end
+
+      def create_resource
+        Ribose::Request.post(resources_path, request_body(attributes))
+      end
+
+      module ClassMethods
+        # Create resource
+        #
+        # @param attributes [Hash] Resoruce attributes
+        # @return [Sawyer::Resource] Newly created resource
+        #
+        def create(attributes)
+          new(attributes).create
+        end
+      end
+    end
+  end
+end

data/lib/ribose/actions/delete.rb

@@ -0,0 +1,32 @@
+require "ribose/actions/base"
+
+module Ribose
+  module Actions
+    module Delete
+      extend Ribose::Actions::Base
+
+      def delete
+        Ribose::Request.delete(resource_path, custom_option)
+      end
+
+      module ClassMethods
+        # Delete a resource
+        #
+        # @param resource_id [String] Resource UUID
+        # @param options [Hash] Query parameters as Hash
+        #
+        def delete(resource_id, options = {})
+          new(resource_id: resource_id, **options).delete
+        end
+
+        # Aliases for delete
+        #
+        # There is another variation `cancel` that we have been using in
+        # some resources inter exchangbly, so let's keep that legacy support
+        # for now and we can decide about those in the future.
+        #
+        alias_method :cancel, :delete
+      end
+    end
+  end
+end

data/lib/ribose/actions/fetch.rb

@@ -0,0 +1,44 @@
+require "ribose/actions/base"
+
+module Ribose
+  module Actions
+    module Fetch
+      extend Ribose::Actions::Base
+
+      # Fetch A Resource
+      #
+      # Retrieve the details for a specific resource via HTTP GET
+      # and retrurns those as `Sawyer::Resource`.
+      #
+      # @return [Sawyer::Resource]
+      #
+      def fetch
+        response = Request.get(resource_path, custom_option)
+        extract_resource(response) || response
+      end
+
+      private
+
+      def extract_resource(response)
+        unless resource.nil?
+          response[resource.to_s]
+        end
+      end
+
+      module ClassMethods
+        # Fetch A Resource
+        #
+        # This exposes the `#fetch` instance method as class methods. Once
+        # this methods is invoked then it will create an instnace with all
+        # of the provided attributes & then invoke the `fetch` action on it
+        #
+        # @param resource_id [String] The specific resource Id
+        # @return [Sawyer::Resource]
+        #
+        def fetch(resource_id, options = {})
+          new(options.merge(resource_id: resource_id)).fetch
+        end
+      end
+    end
+  end
+end

data/lib/ribose/actions/update.rb

@@ -0,0 +1,35 @@
+require "ribose/actions/base"
+
+module Ribose
+  module Actions
+    module Update
+      extend Ribose::Actions::Base
+
+      # Update a resource
+      #
+      # @return [Sawyer::Resource] Update resource response
+      def update
+        update_resource[resource]
+      end
+
+      private
+
+      def update_resource
+        Ribose::Request.put(
+          resource_path, custom_option.merge(resource_key.to_sym => attributes)
+        )
+      end
+
+      module ClassMethods
+        # Update a resource
+        #
+        # @param resource_id [String] The Resource UUID
+        # @param attributes [Hash] New attributes as Hash
+        # @return [Sawyer::Resource] The Updated Resource
+        def update(resource_id, attributes = {})
+          new(attributes.merge(resource_id: resource_id)).update
+        end
+      end
+    end
+  end
+end

data/lib/ribose/app_data.rb

@@ -0,0 +1,15 @@
+module Ribose
+  class AppData < Ribose::Base
+    include Ribose::Actions::All
+
+    private
+
+    def resource
+      "app_data"
+    end
+
+    def resources
+      resource
+    end
+  end
+end

data/lib/ribose/app_relation.rb

@@ -0,0 +1,12 @@
+module Ribose
+  class AppRelation < Ribose::Base
+    include Ribose::Actions::All
+    include Ribose::Actions::Fetch
+
+    private
+
+    def resource
+      "app_relation"
+    end
+  end
+end

data/lib/ribose/base.rb

@@ -0,0 +1,48 @@
+require "ribose/resource_helper"
+
+module Ribose
+  class Base
+    include Ribose::ResourceHelper
+
+    def initialize(attributes = {})
+      @attributes = attributes
+      extract_base_attributes
+      extract_local_attributes
+    end
+
+    private
+
+    attr_reader :resource_id, :attributes, :client, :query
+
+    # User provided options
+    #
+    # Some of the API endpoints has support for custom options,
+    # for example sending a request as different client, pass
+    # some query parameters and etc, and that's where this will
+    # come in handy.
+    #
+    def custom_option
+      { client: client, query: query }
+    end
+
+    # Extract Local Attributes
+    #
+    # This hook method let us extract sub-class specific attributes
+    # And the way to do it is pretty simple, we only need to override
+    # this method and extract the keys from the attributes hash. For
+    # exmaple if `attributes` contains a has key `space_id` and we
+    # want to extract it to a sub-class then we can do it as follow
+    #
+    #   def extract_local_attributes
+    #     @space_id = attributes.delete(:space_id)
+    #   end
+    #
+    def extract_local_attributes; end
+
+    def extract_base_attributes
+      @query = attributes.delete(:query)
+      @client = attributes.delete(:client)
+      @resource_id = attributes.delete(:resource_id)
+    end
+  end
+end

data/lib/ribose/calendar.rb

@@ -0,0 +1,22 @@
+module Ribose
+  class Calendar < Ribose::Base
+    include Ribose::Actions::All
+    include Ribose::Actions::Fetch
+    include Ribose::Actions::Create
+    include Ribose::Actions::Delete
+
+    private
+
+    def resource
+      "calendar"
+    end
+
+    def resources_path
+      "calendar/calendar"
+    end
+
+    def validate(name:, **attributes)
+      attributes.merge(name: name)
+    end
+  end
+end

data/lib/ribose/client.rb

@@ -0,0 +1,31 @@
+module Ribose
+  class Client
+    attr_reader :api_token, :user_email
+
+    def initialize(options = {})
+      @api_token = options.fetch(:token, configuration.api_token).to_s
+      @user_email = options.fetch(:email, configuration.user_email).to_s
+    end
+
+    # Initiate a ribose client
+    #
+    # This interface takes email and password and then it will
+    # do all the underlying work to find out the authentication
+    # token and retrun a ribose client.
+    #
+    # @param :email [String] The email for your Ribose account
+    # @param :password [String] The password for your account
+    # @return [Ribose::Client] A new client with your details
+    #
+    def self.from_login(email:, password:)
+      session = Session.create(username: email, password: password)
+      new(email: email, token: session["authentication_token"])
+    end
+
+    private
+
+    def configuration
+      Ribose.configuration
+    end
+  end
+end

data/lib/ribose/config.rb

@@ -0,0 +1,21 @@
+require "ribose/configuration"
+
+module Ribose
+  module Config
+    def configure
+      if block_given?
+        yield configuration
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  # This following line exposes `Ribose::Config` moduel's methods in class
+  # scope, so we can easily use those to configure or access Ribose config
+  # throughout the gem and the client applications.
+  #
+  extend Config
+end

data/lib/ribose/configuration.rb

@@ -0,0 +1,25 @@
+require "ribose/response/raise_error"
+
+module Ribose
+  class Configuration
+    attr_accessor :api_host, :api_token, :user_email, :debug_mode
+
+    def initialize
+      @debug_mode = false
+      @api_host ||= "www.ribose.com"
+    end
+
+    def debug_mode?
+      debug_mode == true
+    end
+
+    def web_url
+      ["https", api_host].join("://")
+    end
+    def add_default_middleware(builder)
+      builder.use(Ribose::Response::RaiseError)
+      builder.response(:logger, nil, bodies: true) if debug_mode?
+      builder.adapter(Faraday.default_adapter)
+    end
+  end
+end