todoable 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15dee3cddd4486f45a9da0a64584af88cf7d6fac
+  data.tar.gz: 25dc12a3b5990dc10760d51783c48b301c7ffdfc
+SHA512:
+  metadata.gz: 3c76697708465b0cd5234f7fbb4fb755d3d013327a64b9a087385a9d2b3b802402bf56c98439c723f40bebdbad8ad6aee133bc2396dee41f9a420056c0ed2cd6
+  data.tar.gz: 8338f94b1e02912c0276684986e6cd242989f4557f7cfa90e4920802cea1edc8503f6a10097d5ebf02aef2a78c5b6e19fb0ac2ac28136731ffdf55bd80f00716

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at heriberto@melo.nyc. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in todoable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    todoable (1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rest-client (~> 2.0)
+  rspec (~> 3.0)
+  todoable!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,119 @@
+# Todoable
+
+Library wrapper to use the Todoable API.
+
+
+## Pre-Requisite
+Install the gem using bundler
+
+Add to GemFile:
+```
+gem 'todoable', git: 'https://github.com/hmelo1/todoable.git'
+```
+Run a good ol'fashioned bundle install
+
+## Dependencies
+```
+Rest-Client
+Bundler
+Rspec
+Rake
+```
+
+## Clases and Modules
+
+`Todoable::User` < Represents the User currently logged in.
+
+`Todoable::List` < Represents the Lists of Todo Lists
+
+`Todoable::Item` < Represents the individual items going into the Todo List
+
+## Adjustments needed
+* Currently there are no tests running for the items class. Was unable to figure out how to properly test them within the alloted few hours. 
+* Readability within tests could be improved.
+* Some error capturing for errors. RestClient handles some, but more error capturing is needed.
+
+## API EndPoints
+The base URL for all requests is http://todoable.teachable.tech/api
+```
+GET /lists
+POST /lists
+GET /lists/:list_id
+PATCH /lists/:list_id
+DELETE /lists/:list_id
+POST /lists/:list_id/items
+PUT /lists/:list_id/items/:item_id/finish
+DELETE /lists/:list_id/items/:item_id
+```
+## Usage and Methods
+
+~~~~~
+#Provide Authentication credentials
+user = Todoable::User.authenticate_user(username, password)
+~~~~~
+
+~~~~~
+#Populate your lists of todo-lists
+lists = user.list_lists
+~~~~~
+
+~~~~~
+#View your list index
+lists.index
+~~~~~
+
+~~~~~
+#Create a new list with the name "New List"
+lists.create("New List")
+~~~~~
+
+~~~~~
+#Show an individual list
+lists.show(list_id)
+~~~~~
+
+~~~~~
+#Update an individual list
+lists.update(list_id)
+~~~~~
+
+~~~~~
+#Delete an individual list
+lists.delete(list_id)
+~~~~~
+
+~~~~~
+#Add items to an individual list
+item = list_items(list_id)
+~~~~~
+
+~~~~~
+#Create an item in your chosen list.
+item.create("Say hello to the dogs!")
+~~~~~
+
+~~~~~
+#Finish an item
+item.finish(item_id)
+~~~~~
+
+~~~~~
+#Delete an individual item
+item.delete(item_id)
+~~~~~
+
+
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/todoable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Todoable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/todoable/blob/master/CODE_OF_CONDUCT.md).

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 "todoable"
+
+# 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/lib/todoable.rb

@@ -0,0 +1,72 @@
+require "todoable/list"
+require "todoable/item"
+require "rest-client"
+require "json"
+
+module Todoable
+    BASE_ROUTE = 'http://todoable.teachable.tech/api'
+    LISTS_PATH = "/lists"
+
+    class User
+        AUTH_PATH = "/authenticate"
+
+        attr_accessor :username, :password, :token
+        
+        def self.authenticate_user(username, password)
+            user = new
+            user.username = username
+            user.password = password
+            user.token = self.get_token!(user)
+            user
+        end
+
+        def self.get_token!(client)
+            req = RestClient::Request.new(
+                method: :post,
+                url: BASE_ROUTE+AUTH_PATH,
+                user: client.username,
+                password: client.password,
+                headers: {
+                    content_type: :json,
+                    accept: :json
+                }
+            )
+            resp = req.execute {|resp| resp} 
+            if resp.code == 401
+                return "Unauthorized"
+            end 
+            resp = JSON.parse(resp)
+            
+            resp['token']
+        end
+
+        def make_request(path, type, values = nil)
+            data = {
+                method: type,
+                url: BASE_ROUTE+path,
+                headers: {
+                    content_type: :json,
+                    accept: :json,
+                    authorization: "Token token=\"#{token}\""
+                }
+            }
+            if values
+                data.merge!(payload: values.to_json)
+            end
+            req = RestClient::Request.new(data)
+            req = req.execute
+            if type != :delete and type != :patch
+                resp = JSON.parse(req)
+                return resp
+            end
+        end
+
+        def list_lists
+            List.new(self)
+        end
+
+        def list_items(list_id)
+            Item.new(self, list_id)
+        end
+    end
+end

data/lib/todoable/item.rb

@@ -0,0 +1,25 @@
+module Todoable
+    class Item
+        ITEM_PATH = "/items/"
+        FINISH_PATH = "/finish"
+
+        attr_accessor :list_id, :user
+
+        def initialize(user, list_id)
+            @user = user
+            @list_id = list_id
+        end
+
+        def create(content)
+            user.make_request(LISTS_PATH+list_id+ITEM_PATH, :post, { item: {name: content} })
+        end
+
+        def finish(item_id)
+            user.make_request(LISTS_PATH+list_id+ITEM_PATH+item_id+FINISH_PATH, :put)
+        end
+
+        def delete(item_id)
+            user.make_request(LISTS_PATH+list_id+ITEM_PATH+item_id, :delete)
+        end
+    end
+end

data/lib/todoable/list.rb

@@ -0,0 +1,29 @@
+module Todoable
+    class List
+        attr_accessor :name, :list_id, :user
+
+        def initialize(user)
+            @user = user
+        end
+
+        def index
+            user.make_request(LISTS_PATH, :get)['lists']
+        end
+
+        def create(content)
+            user.make_request(LISTS_PATH, :post, { list: {name: content} })
+        end
+
+        def show(id)
+            user.make_request(LISTS_PATH+"/#{id}", :get)
+        end
+
+        def update(id, content)
+            user.make_request(LISTS_PATH+"/#{id}", :patch, {list: {name: content}} )
+        end
+
+        def delete(id)
+            user.make_request(LISTS_PATH+"/#{id}", :delete)
+        end
+    end
+end

data/todoable.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "todoable"
+  spec.version       = "1.0"
+  spec.authors       = ["Eddie Melo"]
+  spec.email         = ["heriberto@melo.nyc"]
+
+  spec.summary       = 'Small gem to interact with Teachable\'s Todoable API'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["source_code_uri"] = "https://github.com/hmelo1/todoable"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rest-client", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: todoable
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Eddie Melo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+description: 
+email:
+- heriberto@melo.nyc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/todoable.rb
+- lib/todoable/item.rb
+- lib/todoable/list.rb
+- todoable.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/hmelo1/todoable
+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: Small gem to interact with Teachable's Todoable API
+test_files: []