boardeffect 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8678828b354b65de0b58c85567ca5c99fcc93ff
+  data.tar.gz: 0eec7f5fa237b33b279609077dd52a317a03a857
+SHA512:
+  metadata.gz: 1a1f7f0dc746bc9c820e00b61f75f6cac91446659de3564ede647e64851c3724e6ae0bb4815e4d2f6bd07aa1250703305347a523e241512f19a52f4ff32836bb
+  data.tar.gz: 01421f98f9ea3b3bb8a663c0c1cda54e98f40c0ed308273b5e4d5ccc19b166f0a4c9ce9958ce0f7c18bb236f89afce48e96c5018d7492b71efc8ba29246e7b67

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+bin*
+pkg

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mark Hunt
+
+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,19 @@
+# boardeffect
+
+Ruby client for [Version 2 of the BoardEffect API].
+
+
+## Install
+
+```
+$ gem install boardeffect
+```
+
+
+## Quick start
+
+```ruby
+require 'boardeffect'
+
+boardeffect = BoardEffect::Client.new(access_token: 'YOUR PERSONAL ACCESS TOKEN', host: 'https://yourportalname.boardeffect.com/')
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :spec
+
+Rake::TestTask.new(:spec) do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+  t.warning = true
+end

data/boardeffect.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boardeffect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "boardeffect"
+  spec.version       = BoardEffect::VERSION
+  spec.authors          = ['Mark Hunt']
+  spec.email            = ['development@boardeffect.com']
+  spec.homepage         = 'https://github.com/magicmarkker/boardeffect'
+  spec.description      = 'Ruby client for Version 2 of the BoardEffect API'
+  spec.summary          = 'Ruby client for Version 2 of the BoardEffect API'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'webmock', '~> 1.24'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/boardeffect.rb

@@ -0,0 +1,37 @@
+require 'boardeffect/client'
+require 'boardeffect/version'
+
+module BoardEffect
+  class Client
+
+    # Announcements
+    def get_announcements(params = nil)
+      get("/services/v2/#{workroom_check(params)}announcements.json", params)
+    end
+
+    def create_announcement(attributes, params = nil)
+      post("/services/v2/#{workroom_check(params)}announcements.json", attributes)
+    end
+
+    def update_announcement(announcement_id, attributes, params = nil)
+      put("/services/v2/#{workroom_check(params)}announcements/#{announcement_id}.json", attributes)
+    end
+
+    def get_announcement(announcement_id, params = nil)
+      get("/services/v2/#{workroom_check(params)}announcements/#{announcement_id}.json")
+    end
+
+    def delete_announcement(announcement_id, params = nil)
+      delete("/services/v2/#{workroom_check(params)}announcements/#{announcement_id}.json")
+    end
+
+    private
+
+    def workroom_check(params = nil)
+      if !params.nil? && params.key?('workroom_id')
+        raise Error, "Workroom ID Can not be 0" if params[:workroom_id].to_i == 0
+        "workrooms/#{params[:workroom_id].to_i}/"
+      end
+    end
+  end
+end

data/lib/boardeffect/client.rb

@@ -0,0 +1,95 @@
+require 'boardeffect/errors'
+require 'boardeffect/record'
+require 'net/http'
+require 'cgi'
+require 'json'
+
+module BoardEffect
+  class Client
+    def initialize(options = {})
+      if options.key?(:access_token)
+        @auth_header, @auth_value = 'Authorization', "Token token=#{options[:access_token]}"
+      else
+        @auth_header, @auth_value = 'X-BoardEffectToken', options.fetch(:token)
+      end
+
+      @user_agent = options.fetch(:user_agent, 'Ruby BoardEffect::Client')
+
+      @host = (options.key?(:host)) ? options[:host] : 'boardeffect.local'
+
+      @http = Net::HTTP.new(@host)
+
+      @http.use_ssl = (options.key?(:host)) ? true : false
+    end
+
+    def get(path, params = nil)
+      request(Net::HTTP::Get.new(request_uri(path, params)))
+    end
+
+    private
+
+    def post(path, attributes)
+      request(Net::HTTP::Post.new(path), attributes)
+    end
+
+    def put(path, attributes = nil)
+      request(Net::HTTP::Put.new(path), attributes)
+    end
+
+    def delete(path)
+      request(Net::HTTP::Delete.new(path))
+    end
+
+    def request(http_request, body_object = nil)
+      http_request['User-Agent'] = @user_agent
+      http_request[@auth_header] = @auth_value
+
+      if body_object
+        http_request['Content-Type'] = 'application/json'
+        http_request.body = JSON.generate(body_object)
+      end
+
+      parse(@http.request(http_request))
+    end
+
+    def parse(http_response)
+      case http_response
+      when Net::HTTPNoContent
+        :no_content
+      when Net::HTTPSuccess
+        if http_response['Content-Type'] && http_response['Content-Type'].split(';').first == 'application/json'
+          JSON.parse(http_response.body, symbolize_names: true, object_class: Record).tap do |object|
+            if http_response['Link'] && next_page = http_response['Link'][/<([^>]+)>; rel="next"/, 1]
+              object.singleton_class.module_eval { attr_accessor :next_page }
+              object.next_page = URI.parse(next_page).request_uri
+            end
+          end
+        else
+          http_response.body
+        end
+      when Net::HTTPBadRequest
+        object = JSON.parse(http_response.body, symbolize_names: true)
+
+        raise Error, "boardeffect api error: #{object.fetch(:message)}"
+      when Net::HTTPUnauthorized
+        raise AuthenticationError
+      else
+        raise Error, "boardeffect api error: unexpected #{http_response.code} response from #{@host}"
+      end
+    end
+
+    def request_uri(path, params = nil)
+      return path if params.nil? || params.empty?
+
+      path + '?' + params.map { |k, v| "#{escape(k)}=#{array_escape(v)}" }.join('&')
+    end
+
+    def array_escape(object)
+      Array(object).map { |value| escape(value) }.join(',')
+    end
+
+    def escape(component)
+      CGI.escape(component.to_s)
+    end
+  end
+end

data/lib/boardeffect/errors.rb

@@ -0,0 +1,5 @@
+module BoardEffect
+  class Error < StandardError; end
+
+  class AuthenticationError < Error; end
+end

data/lib/boardeffect/record.rb

@@ -0,0 +1,31 @@
+module BoardEffect
+  class Record
+    def initialize
+      @attributes = {}
+    end
+
+    def [](name)
+      @attributes[name]
+    end
+
+    def []=(name, value)
+      @attributes[name] = value
+    end
+
+    def method_missing(name, *args, &block)
+      if @attributes.has_key?(name) && args.empty? && block.nil?
+        return @attributes[name]
+      else
+        super name, *args, &block
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @attributes.has_key?(name)
+    end
+
+    def to_h
+      @attributes
+    end
+  end
+end

data/lib/boardeffect/version.rb

@@ -0,0 +1,3 @@
+module BoardEffect
+  VERSION = "0.0.1"
+end

data/spec/boardeffect_spec.rb

@@ -0,0 +1,98 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'boardeffect'
+
+describe 'BoardEffect::Client' do
+  before do
+    @token = 'd9e982b84b624ab761f718a54f5ab682b0dbf9a11e28ed334812a118eeba34ab2200ec00a923b85eb7c848343aadc601b0386b8ea875f7feb931e2674ceaaf8b'
+
+    @base_url = 'http://boardeffect.local/services/v2'
+
+    @entry_id = @project_id = @id = 1234
+
+    @auth_header = {headers: {'Authorization' => "Token token=#{@token}", 'User-Agent'=>'Ruby BoardEffect::Client', 'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}}
+
+    @json_request = {headers: {'Authorization' => "Token token=#{@token}", 'User-Agent'=>'Ruby BoardEffect::Client', 'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}}
+
+    @json_response = {headers: {'Content-Type' => 'application/json;charset=utf-8'}, body: '{}'}
+
+    @client = BoardEffect::Client.new(access_token: @token)
+  end
+
+  after do
+    assert_requested(@request) if defined?(@request)
+  end
+
+  describe "get_announcements method" do
+    it "fetches the announcements resources and returns the decoded response object" do
+      @request = stub_request(:get, "#@base_url/announcements").with(@auth_header).to_return(@json_response.merge(body: '[]'))
+      @client.get_announcements.must_equal([])
+    end
+
+    it 'makes request to get specific workroom announcements' do
+      @request = stub_request(:get, "#@base_url/announcements?workroom_id=1")
+      @client.get_announcements(workroom_id: "1")
+    end
+
+    it 'raises an error if workroom_id is 0' do
+      message = "Workroom ID Can not be 0"
+      @request = stub_request(:get, "#@base_url/announcements?workroom_id=0").to_return(@json_response.merge(status: 400, body: %({"message":"#{message}"})))
+      exception = proc { @client.get_announcements(workroom_id: "0") }.must_raise(BoardEffect::Error)
+      exception.message.must_include(message)
+    end
+  end
+
+  describe "create_announcement method" do
+    it "posts the given attributes to the announcements resource and returns the decoded response object" do
+      @request = stub_request(:post, "#@base_url/announcements").with(@json_request.merge(body: { title: "Testing api", body: "This is a description"})).to_return(@json_response.merge(status: 201))
+      @client.create_announcement(title: "Testing api", body: "This is a description").must_be_instance_of(BoardEffect::Record)
+    end
+  end
+
+  describe "update_announcement method" do
+    it "puts the given attributes to the announcements resource and returns the decoded response object" do
+      @request = stub_request(:put, "#@base_url/announcements/1").with(@json_request.merge(body: { title: "Testing api update", body: "This is a description"})).to_return(@json_response.merge(status: 201))
+      @client.update_announcement(1, {title: "Testing api update", body: "This is a description"}).must_be_instance_of(BoardEffect::Record)
+    end
+  end
+
+  describe "get_announcement method" do
+    it "fetches the announcement resources and returns the decoded response object" do
+      @request = stub_request(:get, "#@base_url/announcements/1").with(@auth_header).to_return(@json_response.merge(body: '[]'))
+      @client.get_announcement(1).must_equal([])
+    end
+  end
+
+  describe "delete_announcement method" do
+    it "deletes the announcement resource" do
+      @request = stub_request(:delete, "#@base_url/announcements/1").with(@auth_header).to_return(status: 204)
+      @client.delete_announcement(1).must_equal(:no_content)
+    end
+  end
+end
+
+describe 'BoardEffect::Record' do
+  before do
+    @record = BoardEffect::Record.new
+
+    @record[:project_id] = 123
+  end
+
+  describe 'square brackets method' do
+    it 'returns the value of the attribute with the given name' do
+      @record[:project_id].must_equal(123)
+    end
+  end
+
+  describe 'method_missing' do
+    it 'returns the value of the attribute with the given name' do
+      @record.project_id.must_equal(123)
+    end
+  end
+
+  describe 'to_h method' do
+    it 'returns a hash containing the record attributes' do
+      @record.to_h.must_equal({project_id: 123})
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: boardeffect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Hunt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Ruby client for Version 2 of the BoardEffect API
+email:
+- development@boardeffect.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- boardeffect.gemspec
+- lib/boardeffect.rb
+- lib/boardeffect/client.rb
+- lib/boardeffect/errors.rb
+- lib/boardeffect/record.rb
+- lib/boardeffect/version.rb
+- spec/boardeffect_spec.rb
+homepage: https://github.com/magicmarkker/boardeffect
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for Version 2 of the BoardEffect API
+test_files:
+- spec/boardeffect_spec.rb