Class: Klaro::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/klaro/client.rb,
lib/klaro/client/errors.rb,
lib/klaro/client/version.rb,
lib/klaro/client/resource.rb,
lib/klaro/client/resource/board.rb,
lib/klaro/client/resource/story.rb,
lib/klaro/client/request_handler.rb,
lib/klaro/client/support/md_text.rb,
lib/klaro/client/resource/stories.rb,
lib/klaro/client/resource/dimension.rb,
lib/klaro/client/resource/attachment.rb,
lib/klaro/client/resource/dimensions.rb,
lib/klaro/client/resource/dimension_value.rb

Defined Under Namespace

Modules: Version Classes: Attachment, Board, Collection, Dimension, DimensionValue, Dimensions, Error, MdText, RequestHandler, Resource, Stories, Story

Constant Summary collapse

VERSION = 
"#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url) ⇒ Client

Returns a new instance of Client.



10
11
12
 
# File 'lib/klaro/client.rb', line 10

def initialize(base_url)
  @request = RequestHandler.new(base_url)
end

Instance Attribute Details

#request ⇒ Object (readonly)

Returns the value of attribute request.



8
9
10
 
# File 'lib/klaro/client.rb', line 8

def request
  @request
end

Instance Method Details

#absolute_url(url) ⇒ Object 



14
15
16
 
# File 'lib/klaro/client.rb', line 14

def absolute_url(url)
  request.base_url + url
end

#board(location_or_id) ⇒ Object 



38
39
40
 
# File 'lib/klaro/client.rb', line 38

def board(location_or_id)
  Board.dress(request.get("/api/boards/#{location_or_id}"), self)
end

#board_stories(location_or_id) ⇒ Object 



42
43
44
 
# File 'lib/klaro/client.rb', line 42

def board_stories(location_or_id)
  Stories.dress(request.get("/api/boards/#{location_or_id}/stories/"), self)
end

#dimension(code_or_id) ⇒ Object 



30
31
32
 
# File 'lib/klaro/client.rb', line 30

def dimension(code_or_id)
  Dimension.dress(request.get("/api/dimensions/#{code_or_id}"), self)
end

#dimensions ⇒ Object 



34
35
36
 
# File 'lib/klaro/client.rb', line 34

def dimensions
  Dimensions.dress(request.get('/api/dimensions'), self)
end

#login(*args, &bl) ⇒ Object 



26
27
28
 
# File 'lib/klaro/client.rb', line 26

def (*args, &bl)
  request.authenticate(*args, &bl)
end

#story(id_or_identifier) ⇒ Object 



46
47
48
 
# File 'lib/klaro/client.rb', line 46

def story(id_or_identifier)
  Story.dress(request.get("/api/stories/#{id_or_identifier}"), self)
end

#upload_image(image_path) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/klaro/client.rb', line 50

def upload_image(image_path)
  body = {
    form: {
      file: HTTP::FormData::File.new(image_path)
    }
  }
  response = request.post('/s/', body)
  URI(response['location']).request_uri
end

#with_project(*args, &bl) ⇒ Object 



22
23
24
 
# File 'lib/klaro/client.rb', line 22

def with_project(*args, &bl)
  request.with_project(*args, &bl)
end

#with_token(*args, &bl) ⇒ Object 



18
19
20
 
# File 'lib/klaro/client.rb', line 18

def with_token(*args, &bl)
  request.with_token(*args, &bl)
end