kipalog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1aa02774e9f553e891a9aec7f5af63e9e2b8b1fb
+  data.tar.gz: 55a7d64d55f63b04928e9e9dffa580c8d104941d
+SHA512:
+  metadata.gz: 4548762600e4ba326dd9a475b15eaa4410a63ff98280babba2661f7c33f7372425b53525061812bd445cbd10e5d6b8dc1e42da6f1b6080301553bb97dd0f2db6
+  data.tar.gz: 6313fad29387e1754a465b9c823840e1f0ab1bf9751d5404734d8e520198e20745b614d39fea4738d4c1179cd54b5d52ebefd5c0aa407f8038d085236f9ab396

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at huynhquancam@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cam Huynh
+
+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,123 @@
+# Kipalog
+
+Ruby wrapper for Kipalog API
+
+Original documentation see at: [https://github.com/Kipalog/Kipalog-API-Doc](https://github.com/Kipalog/Kipalog-API-Doc)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kipalog'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+### IMPORTANT: Configure your API token
+
+```ruby
+Kipalog.configure do |config|
+  config.api_key = 'key-obtained-from-kipalog'
+end
+```
+
+If you're using *Rails*, you might want to consider putting it in `config/initializers/kipalog.rb`
+
+### `Kipalog::Post.preview`
+
+```ruby
+markdown = %{
+  ### FOO
+  * Item A
+  * Item B
+  * Item C
+}
+Kipalog::Post.preview(markdown)
+```
+
+### `Kipalog::Post.create`
+
+
+```ruby
+markdown = %{
+  ### FOO
+  * Item A
+  * Item B
+  * Item C
+}
+
+data = {
+  title: 'Hello World',
+  content: markdown,
+  tag: 'foo,bar',
+  status: 'published' # or "draft"
+}
+Kipalog::Post.create(data)
+```
+
+### `Kipalog::Post.newest`
+
+Get all latest posts on Kipalog.com
+
+```ruby
+Kipalog::Post.newest
+```
+
+### `Kipalog::Post.hot`
+
+Get all the latest posts on Kipalog.com
+
+```ruby
+Kipalog::Post.hot
+```
+
+### `Kipalog::Post.bytag`
+
+Fetch all posts by a specific tag name
+
+```ruby
+Kipalog::Post.bytag('ruby')
+```
+
+## Development
+
+1. Fork this repository.
+2. Add your feature as well as your test (in MiniTest).
+3. Send us a pull request.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/huynhquancam/kipalog. 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](http://opensource.org/licenses/MIT).
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Cam Huynh
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/kipalog.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kipalog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kipalog"
+  spec.version       = Kipalog::VERSION
+  spec.authors       = ["Cam Huynh"]
+  spec.email         = ["huynhquancam@gmail.com"]
+
+  spec.summary       = %q{Ruby Wrapper for Kipalog API}
+  spec.description   = %q{Ruby wrapper for Kipalog API}
+  spec.homepage      = "https://github.com/huynhquancam/kipalog"
+  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['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.14"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+end

data/lib/kipalog.rb

@@ -0,0 +1,21 @@
+require "kipalog/version"
+
+module Kipalog
+  class << self
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+
+  class RequestError < ::StandardError; end
+end
+
+require 'kipalog/configuration'
+require 'kipalog/post'
+require 'kipalog/response'
+require 'kipalog/api_client'
+

data/lib/kipalog/api_client.rb

@@ -0,0 +1,65 @@
+require 'httparty'
+require 'json'
+
+module Kipalog
+  class APIClient
+    BASE_URI = 'kipalog.com/api/v1'.freeze
+    X_KIPALOG_TOKEN = 'X-Kipalog-Token'.freeze
+    ACCEPT_CHARSET = 'Accept-Charset'
+    DEFAULT_CHARSET = 'application/json'
+
+    def initialize(config = Kipalog.config)
+      @config = config
+    end
+
+    def get(path)
+      send_request(:get, path)
+    end
+
+    def post(path, request_body)
+      send_request(:post, path, request_body)
+    end
+
+    def send_request(method, path, body_hash = {})
+      _make_request(method, path, body_hash) do |result|
+        response = Kipalog::Response.new(
+          result.code,
+          result.headers,
+          result.parsed_response
+        )
+
+        if response.ok?
+          response
+        else
+          raise RequestError, response.body
+        end
+      end
+    end
+
+    private
+
+    attr_reader :config
+
+    def _make_request(method, path, body_hash)
+      yield(HTTParty.send(method, path, _request_options(body_hash)))
+    rescue HTTParty::Error => e
+      raise RequestError, e.message
+    end
+
+    def _request_options(body_hash)
+      {
+        base_uri: BASE_URI,
+        body: body_hash.to_json,
+        headers: _headers
+      }
+    end
+
+    def _headers
+      {
+        X_KIPALOG_TOKEN => config.token,
+        ACCEPT_CHARSET => DEFAULT_CHARSET
+      }
+    end
+  end
+end
+

data/lib/kipalog/configuration.rb

@@ -0,0 +1,13 @@
+module Kipalog
+  class Configuration
+
+    KIPALOG_API_KEY = 'KIPALOG_API_KEY'.freeze
+
+    attr_accessor :api_key
+    alias :token :api_key
+
+    def initialize(api_key = '')
+      @api_key = api_key
+    end
+  end
+end

data/lib/kipalog/post.rb

@@ -0,0 +1,29 @@
+module Kipalog
+  class Post
+    class << self
+      def client
+        Kipalog::APIClient.new
+      end
+
+      def preview(content)
+        client.post('/post/preview', content: content)
+      end
+
+      def create(data)
+        client.post('/post', data)
+      end
+
+      def hot
+        client.get('/post/hot')
+      end
+
+      def newest
+        client.get('/post/newest')
+      end
+
+      def bytag(tag_name)
+        client.post('/post/bytag', { tag_name: tag_name })
+      end
+    end
+  end
+end

data/lib/kipalog/response.rb

@@ -0,0 +1,19 @@
+module Kipalog
+  class Response
+    attr_reader :status_code, :headers, :body
+
+    def initialize(status_code, headers, body)
+      @status_code = status_code
+      @headers = headers
+      @body = body
+    end
+
+    def ok?
+      status_code == 200
+    end
+
+    def error?
+      !ok?
+    end
+  end
+end

data/lib/kipalog/version.rb

@@ -0,0 +1,3 @@
+module Kipalog
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: kipalog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cam Huynh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Ruby wrapper for Kipalog API
+email:
+- huynhquancam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kipalog.gemspec
+- lib/kipalog.rb
+- lib/kipalog/api_client.rb
+- lib/kipalog/configuration.rb
+- lib/kipalog/post.rb
+- lib/kipalog/response.rb
+- lib/kipalog/version.rb
+homepage: https://github.com/huynhquancam/kipalog
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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 Kipalog API
+test_files: []