basecamp3 0.1.3

data/lib/basecamp3/request.rb

@@ -0,0 +1,163 @@
+# A class for handling requests
+class Basecamp3::Request
+
+  # Initializes the request object.
+  #
+  # @param [String] access_token the data to send in the request
+  # @param [String] uri
+  def initialize(access_token, uri)
+    @access_token = access_token
+    @uri = uri
+  end
+
+  # Sends the request.
+  #
+  # @param [Symbol] method the symbol of the http method
+  # @param [String] path the request path
+  # @param [Hash] data the request body
+  # @param [String] model the name of the model
+  #
+  # @return [Basecamp3::Model, OpenStruct]
+  def request(method, path, data = nil, model = 'raw')
+    uri = build_request_uri(path)
+    https = build_https_object(uri)
+    request = build_request_object(method, uri)
+
+    request.body = data.to_json unless data.nil?
+
+    get_response(https, request, model)
+  end
+
+  # Sends the get request.
+  #
+  # @param [String] path the request path
+  # @param [Hash] params the get params
+  # @param [String] model the name of the model
+  #
+  # @return [Basecamp3::Model, OpenStruct]
+  def get(path, params = {}, model = 'raw')
+    request(:get, "#{path}#{hash_to_get_query(params)}", nil, model)
+  end
+
+  # Sends the post request.
+  #
+  # @param [String] path the request path
+  # @param [Hash] data the request body
+  # @param [String] model the name of the model
+  #
+  # @return [Basecamp3::Model, OpenStruct]
+  def post(path, data = nil, model = 'raw')
+    request(:post, path, data, model)
+  end
+
+  # Sends the put request.
+  #
+  # @param [String] path the request path
+  # @param [Hash] data the request body
+  # @param [String] model the name of the model
+  #
+  # @return [Basecamp3::Model, OpenStruct]
+  def put(path, data = nil, model = 'raw')
+    request(:put, path, data, model)
+  end
+
+  # Sends the delete request.
+  #
+  # @param [String] path the request path
+  # @param [String] model the name of the model
+  #
+  # @return [Basecamp3::Model, OpenStruct]
+  def delete(path, model = 'raw')
+    request(:delete, path, nil, model)
+  end
+
+  private
+
+  # Returns the response.
+  #
+  # @private
+  #
+  # @param [Net:HTTP] https the http object
+  # @param [Net::HTTP::Get, Net::HTTP::Post, Net::HTTP::Put, Net::HTTP::Delete] request the request object
+  # @param [Class] model the class of the model
+  #
+  # @return [Basecamp3::Model, OpenStruct]
+  def get_response(https, request, model)
+    response = https.request(request)
+
+    code = response.code.to_i
+    message = response.message
+
+    raise message if [400, 403, 404, 507].include?(code)
+
+    return true if code == 204
+
+    json = response.body.nil? ? nil : JSON.parse(response.body)
+
+    return json if model == 'raw'
+
+    Basecamp3::ResponseParser.parse(json, model)
+  end
+
+  # Builds the request uri.
+  #
+  # @private
+  #
+  # @param [String] path the path of the request
+  #
+  # @return [String]
+  def build_request_uri(path)
+    uri = URI.parse("#{@uri}#{path}")
+    uri.path += '.json'
+
+    uri
+  end
+
+  # Builds the https object.
+  #
+  # @private
+  #
+  # @param [String] uri the request uri
+  #
+  # @return [Net::HTTP]
+  def build_https_object(uri)
+    https = Net::HTTP.new(uri.host, uri.port)
+    https.use_ssl = true
+
+    https
+  end
+
+  # Builds the request object.
+  #
+  # @private
+  #
+  # @param [Symbol] method the symbol of the http method
+  # @param [String] uri the request uri
+  #
+  # @return [Net::HTTP::Get, Net::HTTP::Post, Net::HTTP::Put, Net::HTTP::Delete]
+  # @raise [StandardError] raises an error for unsupported http method
+  def build_request_object(method, uri)
+    raise "Unsupported http method: #{method.to_s}" unless [:get, :post, :put, :delete].include?(method)
+
+    request = Object.const_get("Net::HTTP::#{method.to_s.capitalize}").new(uri.request_uri)
+    request['Authorization'] = "Bearer #{@access_token}"
+    request['Content-Type'] = 'application/json'
+
+    request
+  end
+
+  # Builds get query string from the given hash.
+  #
+  # @private
+  #
+  # @param [Hash] hash
+  #
+  # @return [String]
+  def hash_to_get_query(hash)
+    if !hash.nil? && !hash.empty?
+      "?#{hash.map{ |i, v| "#{i}=#{v}" }.join('&')}"
+    else
+      ''
+    end
+  end
+end

data/lib/basecamp3/response_parser.rb

@@ -0,0 +1,44 @@
+# The basecamp response parser
+class Basecamp3::ResponseParser
+
+  # Parses the given response to the given wrapper model.
+  #
+  # @param [Hash] response The hash with data which should be parsed to the wrapper model
+  # @param [Class] model The class of the model
+  #
+  # @return [Basecamp3::Model, Array<Basecamp3::Model>, nil]
+  # @raise [StandardError] raises an error for unsupported response type
+  def self.parse(response, model)
+    case response
+    when Hash
+      map_object(response, model)
+    when Array
+      response.map do |item|
+        map_object(item, model)
+      end
+    when NilClass
+      nil
+    else
+      raise 'Unsupported response type'
+    end
+  end
+
+  private
+
+  # Parses the given hash to the given wrapper model.
+  #
+  # @private
+  #
+  # @param [Hash] object The hash with data which should be parsed to the wrapper model
+  # @param [Class] model The class of the model
+  #
+  # @return [Basecamp3::Model]
+  # @raise [StandardError] raises an error for unsupported model type
+  def self.map_object(object, model)
+    begin
+      model.new(object)
+    rescue
+      raise 'Unsupported model type. Try to call for a raw response'
+    end
+  end
+end

data/lib/basecamp3/type_mapper.rb

@@ -0,0 +1,53 @@
+# The basecamp type to wrapper type mapper
+class Basecamp3::TypeMapper
+
+  # Maps the basecamp model type to wrapper model type.
+  #
+  # @param [String] basecamp_type the basecamp model name
+  #
+  # @return [Class, OpenStruct]
+  def self.map(basecamp_type)
+    case basecamp_type
+    when 'Project'
+      Basecamp3::Project
+    when 'Chat::Transcript'
+      Basecamp3::Campfire
+    when 'Chat::Lines::Text'
+      Basecamp3::CampfireLine
+    when 'Comment'
+      Basecamp3::Comment
+    when 'Document'
+      Basecamp3::Document
+    when 'Inbox::Forward'
+      Basecamp3::Forward
+    when 'Inbox'
+      Basecamp3::Inbox
+    when 'Message::Board'
+      Basecamp3::MessageBoard
+    when 'Message'
+      Basecamp3::Message
+    when 'User'
+      Basecamp3::Person
+    when 'Question::Answer'
+      Basecamp3::QuestionAnswer
+    when 'Questionnaire'
+      Basecamp3::Questionnaire
+    when 'Question'
+      Basecamp3::Question
+    when 'Schedule::Entry'
+      Basecamp3::ScheduleEntry
+    when 'Schedule'
+      Basecamp3::Schedule
+    when 'Todolist'
+      Basecamp3::TodoList
+    when 'Todo'
+      Basecamp3::Todo
+    when 'Todoset'
+      Basecamp3::TodoSet
+    when 'Vault'
+      Basecamp3::Vault
+    else
+      OpenStruct
+    end
+  end
+end

data/lib/basecamp3/version.rb

@@ -0,0 +1,3 @@
+module Basecamp3
+  VERSION = "0.1.3"
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: basecamp3
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- goth-pl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+description: A simple Ruby Wrapper for the Basecamp 3 API
+email:
+- m.szycko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- basecamp3.gemspec
+- bin/console
+- bin/setup
+- docs/Basecamp3.html
+- docs/Basecamp3/Campfire.html
+- docs/Basecamp3/CampfireLine.html
+- docs/Basecamp3/Comment.html
+- docs/Basecamp3/Concerns.html
+- docs/Basecamp3/Concerns/Bucketable.html
+- docs/Basecamp3/Concerns/Commentable.html
+- docs/Basecamp3/Concerns/Creatorable.html
+- docs/Basecamp3/Concerns/Parentable.html
+- docs/Basecamp3/Concerns/Recordingable.html
+- docs/Basecamp3/Concerns/Recordingable/ClassMethods.html
+- docs/Basecamp3/Document.html
+- docs/Basecamp3/Forward.html
+- docs/Basecamp3/Inbox.html
+- docs/Basecamp3/Message.html
+- docs/Basecamp3/MessageBoard.html
+- docs/Basecamp3/MessageType.html
+- docs/Basecamp3/Model.html
+- docs/Basecamp3/Person.html
+- docs/Basecamp3/Project.html
+- docs/Basecamp3/Question.html
+- docs/Basecamp3/QuestionAnswer.html
+- docs/Basecamp3/Questionnaire.html
+- docs/Basecamp3/Request.html
+- docs/Basecamp3/ResponseParser.html
+- docs/Basecamp3/Schedule.html
+- docs/Basecamp3/ScheduleEntry.html
+- docs/Basecamp3/Todo.html
+- docs/Basecamp3/TodoList.html
+- docs/Basecamp3/TodoSet.html
+- docs/Basecamp3/TypeMapper.html
+- docs/Basecamp3/Vault.html
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
+- lib/basecamp3.rb
+- lib/basecamp3/concerns/bucketable.rb
+- lib/basecamp3/concerns/commentable.rb
+- lib/basecamp3/concerns/creatorable.rb
+- lib/basecamp3/concerns/parentable.rb
+- lib/basecamp3/concerns/recordingable.rb
+- lib/basecamp3/model.rb
+- lib/basecamp3/models/campfire.rb
+- lib/basecamp3/models/campfire_line.rb
+- lib/basecamp3/models/comment.rb
+- lib/basecamp3/models/document.rb
+- lib/basecamp3/models/forward.rb
+- lib/basecamp3/models/inbox.rb
+- lib/basecamp3/models/message.rb
+- lib/basecamp3/models/message_board.rb
+- lib/basecamp3/models/message_type.rb
+- lib/basecamp3/models/person.rb
+- lib/basecamp3/models/project.rb
+- lib/basecamp3/models/question.rb
+- lib/basecamp3/models/question_answer.rb
+- lib/basecamp3/models/questionnaire.rb
+- lib/basecamp3/models/schedule.rb
+- lib/basecamp3/models/schedule_entry.rb
+- lib/basecamp3/models/todo.rb
+- lib/basecamp3/models/todo_list.rb
+- lib/basecamp3/models/todo_set.rb
+- lib/basecamp3/models/vault.rb
+- lib/basecamp3/request.rb
+- lib/basecamp3/response_parser.rb
+- lib/basecamp3/type_mapper.rb
+- lib/basecamp3/version.rb
+homepage: https://github.com/miastologia/basecamp3-api-wrapper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Basecamp3 API Wrapper
+test_files: []