height-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b45bd952c9fcf17f329987f231db25cec405e9b6f2e1917ab974f90cc458a5a1
+  data.tar.gz: 36f22f469e81fffffc74ab8155452efb6b44e592c30f2c813cb324a530c1c7b7
+SHA512:
+  metadata.gz: d69e0344946cf9814d2fcce3cea22c383ef08d1108c932e97e61b91defac66278e5a59b984fd74a044d336d02497faa5fb5e15389d4dcc66a594abcc2f26c1a0
+  data.tar.gz: 7f4faad3d023507bc7393fd3628aad60e661a55cb507a9a75700f681de66530c0e05a0d7e3a7d8b0b3848b9a02da7b9b8647094829256abce989f22a31ff7d61

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.envrc
+.byebug_history
+
+tags

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.0.1 Initial release
+
+- List lists
+- List tasks in a list
+- Find task

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in height-api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    height-api (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    vcr (6.0.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  height-api!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mauro Morales
+
+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,72 @@
+# Height API Ruby Gem
+
+_**Warning**: This is still a work in progress. Expect changes in the API_
+
+This gem is a Ruby implementation for [Height.app](https://height.app/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'height-api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install height-api
+
+## Configuration
+
+Set the environment variable `HEIGHT_API_KEY`
+
+## Usage
+
+Create an instance of the client
+
+```ruby
+height = Height.new
+```
+
+From the client you can list lists
+
+```ruby
+height.lists.list
+```
+
+The result will be of type `Height::ListResponse` which you can access like any
+other enumerable. Each item will be of a `Height::Model` type and have its own
+methods. For example, we can get all tasks in a list
+
+```ruby
+lists = height.lists.list
+tasks = lists.first.task
+```
+
+You can also get a task if you know the index or id
+
+```ruby
+task = height.tasks.get(2)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/mauromorales/height-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "height/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/height-api.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/height/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "height-api"
+  spec.version       = Height::VERSION
+  spec.authors       = ["Mauro Morales"]
+  spec.email         = ["contact@mauromorales.com"]
+
+  spec.summary       = %q{Ruby implementation for Height's API}
+  spec.description   = %q{Ruby implementation for Height's API}
+  spec.homepage      = "https://github.com/mauromorales/height-api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/mauromorales/height-api/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency 'byebug', '~> 11.1.3'
+  spec.add_development_dependency 'vcr', '~> 6.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.12.2'
+end

data/lib/height-api.rb

@@ -0,0 +1 @@
+require 'height'

data/lib/height.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'net/http'
+
+require 'height/api'
+require 'height/client'
+require 'height/response'
+require 'height/list_response'
+require 'height/model'
+require 'height/request'
+
+module Height
+  class << self
+    def new
+      Height::Client.new
+    end
+  end
+end

data/lib/height/api.rb

@@ -0,0 +1,4 @@
+module Height::API
+  require 'height/api/lists'
+  require 'height/api/tasks'
+end

data/lib/height/api/lists.rb

@@ -0,0 +1,9 @@
+class Height::API::Lists
+  class << self
+    def list
+      res = Height::Request.get('lists')
+
+      Height::ListResponse.parse(res.body)
+    end
+  end
+end

data/lib/height/api/tasks.rb

@@ -0,0 +1,17 @@
+class Height::API::Tasks
+  class << self
+    def search(filter)
+      query = { 'filters' => filter.to_json }
+      res = Height::Request.get('tasks', query)
+
+      Height::ListResponse.parse(res.body)
+    end
+
+    def get(id_or_index)
+      res = Height::Request.get("tasks/#{id_or_index}")
+
+      Height::Response.parse(res.body)
+    end
+  end
+end
+

data/lib/height/client.rb

@@ -0,0 +1,9 @@
+class Height::Client
+  def lists
+    Height::API::Lists
+  end
+
+  def tasks
+    Height::API::Tasks
+  end
+end

data/lib/height/list_response.rb

@@ -0,0 +1,28 @@
+class Height::ListResponse
+  include ::Enumerable
+
+  class << self
+    def parse(json)
+      response = JSON.parse(json)
+      items = response['list'].map { |item| Height::Model.for(item) }
+
+      new(items)
+    end
+  end
+
+  def initialize(items)
+    @items = items
+  end
+
+  def empty?
+    count.zero?
+  end
+
+  def count
+    @items.count
+  end
+
+  def each(&block)
+    @items.each(&block)
+  end
+end

data/lib/height/model.rb

@@ -0,0 +1,11 @@
+require 'height/model/base'
+require 'height/model/list'
+require 'height/model/task'
+
+module Height::Model
+  def self.for(attrs)
+    model = attrs['model'].capitalize
+
+    Object.const_get("Height::Model::#{model}").new(attrs)
+  end
+end

data/lib/height/model/base.rb

@@ -0,0 +1,12 @@
+module Height::Model
+  class Base
+    def initialize(attrs)
+      self.attributes.each do |key|
+        self.instance_variable_set("@#{key}", attrs[key.to_s])
+        define_singleton_method(key) do
+          self.instance_variable_get("@#{key}")
+        end
+      end
+    end
+  end
+end

data/lib/height/model/list.rb

@@ -0,0 +1,17 @@
+module Height::Model
+  class List < Base
+    def attributes
+      [:id, :type, :key, :description, :url, :appearence]
+    end
+
+    def tasks
+      filters = {
+        "listIds" => {
+          "values" => [id]
+        }
+      }
+
+      Height::API::Tasks.search(filters)
+    end
+  end
+end

data/lib/height/model/task.rb

@@ -0,0 +1,12 @@
+module Height::Model
+  class Task < Base
+    def attributes
+      [
+        :id, :index, :list_ids, :name, :description, :status,
+        :assignees_ids, :parent_task_id, :fields, :deleted, :deleted_at,
+        :deleted_by_user_id, :completed, :completed_at, :created_at,
+        :created_user_id, :last_activity_at, :url
+      ]
+    end
+  end
+end

data/lib/height/request.rb

@@ -0,0 +1,15 @@
+class Height::Request
+  def self.get(endpoint, query = nil)
+    uri = URI("https://api.height.app/#{endpoint}")
+    http = Net::HTTP.new(uri.hostname, uri.port)
+    http.use_ssl = true
+    headers = {
+      'Authorization' => "api-key #{ENV['HEIGHT_API_KEY']}",
+      'Content-Type' => 'application/json'
+    }
+    uri.query = URI.encode_www_form(query) if query 
+    req = Net::HTTP::Get.new(uri, headers)
+
+    http.request(req)
+  end
+end

data/lib/height/response.rb

@@ -0,0 +1,8 @@
+class Height::Response
+  class << self
+    def parse(json)
+      response = JSON.parse(json)
+      Height::Model.for(response)
+    end
+  end
+end

data/lib/height/version.rb

@@ -0,0 +1,3 @@
+module Height
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: height-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mauro Morales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.2
+description: Ruby implementation for Height's API
+email:
+- contact@mauromorales.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- height-api.gemspec
+- lib/height-api.rb
+- lib/height.rb
+- lib/height/api.rb
+- lib/height/api/lists.rb
+- lib/height/api/tasks.rb
+- lib/height/client.rb
+- lib/height/list_response.rb
+- lib/height/model.rb
+- lib/height/model/base.rb
+- lib/height/model/list.rb
+- lib/height/model/task.rb
+- lib/height/request.rb
+- lib/height/response.rb
+- lib/height/version.rb
+homepage: https://github.com/mauromorales/height-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mauromorales/height-api
+  source_code_uri: https://github.com/mauromorales/height-api
+  changelog_uri: https://github.com/mauromorales/height-api/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby implementation for Height's API
+test_files: []