camp3 0.0.1

data/lib/camp3/paginated_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Camp3
+  # Wrapper class of paginated response.
+  class PaginatedResponse
+    attr_accessor :client
+
+    def initialize(array)
+      @array = array
+    end
+
+    def ==(other)
+      @array == other
+    end
+
+    def inspect
+      @array.inspect
+    end
+
+    def method_missing(name, *args, &block)
+      if @array.respond_to?(name)
+        @array.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super || @array.respond_to?(method_name, include_private)
+    end
+
+    def parse_headers!(headers)
+      @links = PageLinks.new headers
+    end
+
+    def each_page
+      current = self
+      yield current
+      while current.has_next_page?
+        current = current.next_page
+        yield current
+      end
+    end
+
+    def lazy_paginate
+      to_enum(:each_page).lazy.flat_map(&:to_ary)
+    end
+
+    def auto_paginate(&block)
+      return lazy_paginate.to_a unless block_given?
+
+      lazy_paginate.each(&block)
+    end
+
+    def paginate_with_limit(limit, &block)
+      return lazy_paginate.take(limit).to_a unless block_given?
+
+      lazy_paginate.take(limit).each(&block)
+    end
+
+    def last_page?
+      !(@links.nil? || @links.last.nil?)
+    end
+    alias has_last_page? last_page?
+
+    def last_page
+      return nil if @client.nil? || !has_last_page?
+
+      @client.get(client_relative_path(@links.last))
+    end
+
+    def first_page?
+      !(@links.nil? || @links.first.nil?)
+    end
+    alias has_first_page? first_page?
+
+    def first_page
+      return nil if @client.nil? || !has_first_page?
+
+      @client.get(client_relative_path(@links.first))
+    end
+
+    def next_page?
+      !(@links.nil? || @links.next.nil?)
+    end
+    alias has_next_page? next_page?
+
+    def next_page
+      return nil if @client.nil? || !has_next_page?
+
+      @client.get(client_relative_path(@links.next))
+    end
+
+    def prev_page?
+      !(@links.nil? || @links.prev.nil?)
+    end
+    alias has_prev_page? prev_page?
+
+    def prev_page
+      return nil if @client.nil? || !has_prev_page?
+
+      @client.get(client_relative_path(@links.prev))
+    end
+
+    def client_relative_path(link)
+      client_endpoint_path = URI.parse(@client.endpoint).request_uri # api/v4
+      URI.parse(link).request_uri.sub(client_endpoint_path, '')
+    end
+  end
+end

data/lib/camp3/request.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require 'httparty'
+require 'json'
+
+module Camp3
+  # @private
+  class Request
+    include HTTParty
+    format :plain
+    headers 'Accept' => 'application/json'
+
+    attr_accessor :access_token
+
+    # Converts the response body to an ObjectifiedHash.
+    def self.parse(body)
+      body = decode(body)
+
+      if body.is_a? Hash
+        Resource.create(body)
+      elsif body.is_a? Array
+        PaginatedResponse.new(body.collect! { |e| Resource.create(e) })
+      elsif body
+        true
+      elsif !body
+        false
+      elsif body.nil?
+        false
+      else
+        raise Error::Parsing, "Couldn't parse a response body"
+      end
+    end
+
+    # Decodes a JSON response into Ruby object.
+    def self.decode(response)
+      response ? JSON.parse(response) : {}
+    rescue JSON::ParserError
+      raise Error::Parsing, 'The response is not a valid JSON'
+    end
+
+    %w[get post put delete].each do |method|
+      define_method method do |path, options = {}|
+        override_path = options.delete(:override_path)
+        params = options.dup
+
+        params[:headers] ||= {}
+        params[:headers].merge!(authorization_header)
+
+        full_endpoint = override_path ? path : Camp3.api_endpoint + path
+
+        validate self.class.send(method, full_endpoint, params)
+      end
+    end
+
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      error_klass = Error::STATUS_MAPPINGS[response.code]
+      raise error_klass, response if error_klass
+
+      parsed = self.class.parse(response)
+      parsed.client = self if parsed.respond_to?(:client=)
+      parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
+      parsed
+    end
+
+    private
+
+    # Returns an Authorization header hash
+    #
+    # @raise [Error::MissingCredentials] if access_token and auth_token are not set.
+    def authorization_header
+      raise Error::MissingCredentials, 'Please provide a access_token' unless @access_token
+
+      { 'Authorization' => "Bearer #{@access_token}" }
+    end
+  end
+end

data/lib/camp3/resource.rb

@@ -0,0 +1,22 @@
+module Camp3
+  class Resource < ObjectifiedHash
+
+    Dir[File.expand_path('resources/*.rb', __dir__)].each { |f| require f }
+
+    def self.create(hash)
+      klass = detect_type(hash["url"])
+
+      return klass.new(hash)
+    end
+
+    def self.detect_type(url)
+      Camp3.logger.debug "Request URL: #{url}" 
+      case url
+      when /#{Camp3.api_endpoint}\/projects\/\d+\.json/
+        return Project
+      else
+        return Resource
+      end
+    end
+  end
+end

data/lib/camp3/resources/project.rb

@@ -0,0 +1,14 @@
+module Camp3
+  class Project < Resource
+
+    attr_reader :message_board, :todoset, :schedule
+
+    def initialize(hash)
+      super
+
+      @message_board = dock.find { |payload| payload.name == 'message_board' }
+      @todoset = dock.find { |payload| payload.name == 'todoset' }
+      @schedule = dock.find { |payload| payload.name == 'schedule' }
+    end
+  end
+end

data/lib/camp3/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Camp3
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: camp3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- renehernandez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: rack-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: 
+email:
+- renehr9102@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/ci.yml"
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- camp3.gemspec
+- examples/messages.rb
+- examples/oauth.rb
+- examples/obtain_acces_token.rb
+- examples/todos.rb
+- lib/camp3.rb
+- lib/camp3/api/message.rb
+- lib/camp3/api/project.rb
+- lib/camp3/api/resource.rb
+- lib/camp3/api/todo.rb
+- lib/camp3/authorization.rb
+- lib/camp3/client.rb
+- lib/camp3/configuration.rb
+- lib/camp3/error.rb
+- lib/camp3/logging.rb
+- lib/camp3/objectified_hash.rb
+- lib/camp3/page_links.rb
+- lib/camp3/paginated_response.rb
+- lib/camp3/request.rb
+- lib/camp3/resource.rb
+- lib/camp3/resources/project.rb
+- lib/camp3/version.rb
+homepage: https://github.com/renehernandez/camp3
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/renehernandez/camp3
+  source_code_uri: https://github.com/renehernandez/camp3
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for Basecamp 3 API
+test_files: []