nexboard-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e047c812b6cf48c7a5547a9050bdc065cc6cd24
+  data.tar.gz: 6774b3d922aa629043e442a394db4c0f90c316bd
+SHA512:
+  metadata.gz: ceb3c2311b48125696bcd32ce2800cfe37ea2d4e423a6c797212bd926c0d8ca1d93e786bf12658e2e7dce3dcad4ebb5df86e962841104084358615e9df8fe81c
+  data.tar.gz: da197a3152093c18ebbfddf7a8d8d8dafc29f64c06aa2341346c4291f001222086c9c98101355ee5f852d264682fe9c7a0c4c0c122554e6f7c26356887cfdb15

data/README.md

@@ -0,0 +1,33 @@
+# Nexboard API
+
+`nexboard-api` is a wrapper for the Nexboard API (see http://nexboard-api.nexenio.com/) packaged as Ruby Gem.
+
+The gem uses Restify (https://github.com/jgraichen/restify) for handling HTTP communication.
+
+## Usage
+Initialize the API with `API key` and `user_id` (both provided with your Nexboard API account). You can optionally add a `template_project_id`, which would be a Nexboard `project_id` where you store boards meant as templates for your application. If you run your own Nexboard server, you can add a custom `base_url`.
+
+```ruby
+require 'nexboard_api'
+
+params = {
+  api_key = 'my_secret_api_key',
+  user_id = 1,
+  template_project_id = 123,
+  base_url = 'https://my-server.example.com/api/public/'
+}
+
+nexboard_api = NexboardApi.new **params
+
+```
+
+tbc.
+
+## Contributing
+
+- Fork it
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit specs for your feature so that I do not break it later
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin my-new-feature)
+- Create new Pull Request

data/lib/nexboard_api.rb

@@ -0,0 +1,62 @@
+class NexboardApi
+  DEFAULT_BASE_URL = 'https://nexboard.nexenio.com/portal/api/public/'.freeze
+
+  attr_reader :api_key, :user_id, :template_project_id, :base_url
+
+  def initialize(api_key:, user_id:, template_project_id: nil, base_url: nil)
+    @api_key             = api_key
+    @user_id             = user_id
+    @template_project_id = template_project_id unless template_project_id.nil?
+    @base_url            = if base_url.nil?
+                             DEFAULT_BASE_URL
+                           else
+                             base_url
+                           end    
+  end
+    
+  def get_project_ids
+    projects = Restify.new(@base_url + 'projects')
+                   .get(userId: @user_id, token: @api_key)
+                   .value!
+
+    projects.data.map{|project| project['project_id']}
+  end
+
+  def create_project(title:, description:)
+    data = {
+        title: title,
+        description: description,
+        user_id: @user_id
+    }
+
+    Restify.new(@base_url + 'projects')
+        .post(data, token: @api_key)
+        .value!
+  end
+
+  def get_boards_for_project(project_id:)
+    Restify.new(@base_url + 'projects/{project_id}/boards')
+        .get(project_id: project_id, token: @api_key, userId: @user_id)
+        .value!
+  end
+
+  def get_template_boards
+    return [] if @template_project_id.nil?
+    template_boards = get_boards_for_project(project_id: @template_project_id)
+    template_boards.data.map{ |board| {board_id: board['boardId'], title: board['title'] } }
+  end
+
+  def create_board_for_project(project_id:, title:, description:, template_id: nil)
+    data = {
+        project_id: project_id,
+        title: title,
+        description: description,
+        user_id: @user_id
+    }
+    data.merge!(template_id: template_id) unless template_id.nil?
+
+    Restify.new(@base_url + 'boards')
+        .post(data, token: @api_key)
+        .value!
+  end
+end

data/nexboard-api.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'nexboard-api'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Xikolo Development Team']
+  spec.email         = %w(xikolo-dev@hpi.uni-potsdam.de)
+  spec.description   = %q{Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)}
+  spec.summary       = %q{Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)}
+  spec.homepage      = 'https://github.com/openHPI/nexboard-api'
+  spec.license       = ''
+
+  spec.files         = Dir['**/*'].grep(/((bin|lib|test|spec|features)\/|
+    .*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)/x)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency 'restify'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+end

data/spec/lib/nexboard_api_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe NexboardApi do
+  let(:api_key) { 'RandomApiKey' }
+  let(:user_id) { 1337 }
+  let(:params)  { {api_key: api_key, user_id: user_id} }
+
+  let(:api)     { NexboardApi.new **params }
+
+  let(:default_base_url) { 'https://nexboard.nexenio.com/portal/api/public/' }
+  let(:default_headers)  { {'Content-Type' => 'application/json'} }
+
+  describe '#initialize' do
+    subject { NexboardApi.new **params }
+
+    it 'should be initialized with correct params' do
+      expect(subject.api_key).to eq(api_key)
+      expect(subject.user_id).to eq(user_id)
+      expect(subject.base_url).to eq(default_base_url)
+    end
+
+    context 'with custom base_url' do
+      let(:params) { super().merge(base_url: 'https://p3k.com') }
+
+      it 'should be initialized with custom base_url' do
+        expect(subject.base_url).to eq('https://p3k.com')
+      end  
+    end  
+
+    context 'with template_project_id' do
+      let(:params) { super().merge(template_project_id: 666) }
+
+      it 'should be initialized with template_project_id' do
+        expect(subject.template_project_id).to eq(666)
+      end  
+    end 
+  end
+
+  describe '#get_project_ids' do
+    subject { api.get_project_ids }
+
+    let!(:projects_stub) do
+      stub_request(:get, "#{default_base_url}projects?token=#{api_key}&userId=#{user_id}").
+         with(headers: default_headers).
+         to_return(status: 200, body: "[{\"project_id\": 1}, {\"project_id\": 3000}]", headers: default_headers)
+    end  
+
+    it 'should request Nexboard API' do
+      subject
+      expect(projects_stub).to have_been_requested
+    end 
+
+    it 'should return a list of project ids' do
+      expect(subject).to eq([1, 3000])
+    end  
+  end
+
+  describe '#create_project' do
+    let(:create_params) { {title: 'My project', description: 'My description'} }
+
+    subject { api.create_project **create_params }
+
+    let!(:create_project_stub) do
+      stub_request(:post, "#{default_base_url}projects?token=#{api_key}").
+         with(headers: default_headers, body: create_params.merge(user_id: user_id)).
+         to_return(status: 200, body: "{}", headers: default_headers)
+    end
+
+    it 'should request Nexboard API' do
+      subject
+      expect(create_project_stub).to have_been_requested
+    end 
+  end
+
+  describe '#get_boards_for_project' do
+    let(:project_id) { 123 }
+
+    subject { api.get_boards_for_project project_id: project_id }
+
+    let(:board) do
+      {
+        boardId: 1,
+        project_id: project_id,
+        title: 'My board',
+        description: 'My description'
+      }
+    end  
+
+    let!(:boards_stub) do
+      stub_request(:get, "#{default_base_url}projects/#{project_id}/boards?token=#{api_key}&userId=#{user_id}").
+         with(headers: default_headers).
+         to_return(status: 200, body: "[#{board.to_json}]", headers: default_headers)
+    end
+
+    it 'should request Nexboard API' do
+      subject
+      expect(boards_stub).to have_been_requested
+    end
+
+    it 'should return a list of board resources' do
+      expect(subject.data.to_json).to eq([board].to_json)
+    end 
+  end
+
+  describe '#create_board_for_project' do
+    let(:create_params) { {project_id: 123, title: 'My title', description: 'My description'} }
+
+    subject { api.create_board_for_project **create_params }
+
+    let(:create_board_stub) do
+      stub_request(:post, "#{default_base_url}boards?token=#{api_key}").
+         with(headers: default_headers, body: create_params.merge(user_id: user_id)).
+         to_return(status: 200, body: "{}", headers: default_headers)
+    end
+
+    before { create_board_stub; subject }
+
+    it 'should request Nexboard API' do
+      expect(create_board_stub).to have_been_requested
+    end 
+
+    context 'with template_id' do
+      let(:create_params) { super().merge(template_id: 1234) }
+
+      it 'should request Nexboard API' do
+        expect(create_board_stub).to have_been_requested
+      end 
+    end  
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'simplecov'
+SimpleCov.start do
+  at_exit do
+    result = SimpleCov.result
+    SimpleCov::Formatter::HTMLFormatter.new.format result
+  end
+end
+
+require 'rspec'
+require 'webmock/rspec'
+require 'nexboard_api'
+require 'restify'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir['spec/support/**/*.rb'].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: nexboard-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xikolo Development Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: restify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)
+email:
+- xikolo-dev@hpi.uni-potsdam.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/nexboard_api.rb
+- nexboard-api.gemspec
+- spec/lib/nexboard_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/openHPI/nexboard-api
+licenses:
+- ''
+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.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)
+test_files:
+- spec/lib/nexboard_api_spec.rb
+- spec/spec_helper.rb