github_markdown_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d914dac7a1db4e9a8d926e7786f7b555ca81613a
-  data.tar.gz: 2f8a4a7e1333fcc78f27890875dc80f1853d44fd
+  metadata.gz: b0f51deadfe6eb8a74ec96e94c26032aa15e4732
+  data.tar.gz: 9de0644d7834a2a2543e54ebc34c8386bc8e5704
 SHA512:
-  metadata.gz: d30dd29cc4fb70bbff25dfb8de2f96cffefb30b983cdc0b3234cf9b0360627f3f7cd4f9fd5200bc42ebd9b5418e63d63fa19cfe172c396206d16bb94523034ea
-  data.tar.gz: 559747ada9b2946fa967a1cdb26e26e6a93ac05f97c569812423d64a9182448d4c21cf89fd6b0c8245b92d56409bf5616eb9b98675a08f9a9b96979109e6c4b0
+  metadata.gz: 397ef2cdb9b4a14cc48aefc52c97399cfd8182b9fbbf481139b8cfa6f645fe4e2e9bb23b59a6e85f92aaa7776bbbb483fa82bafcd484fc716818c56d3f245bd6
+  data.tar.gz: f0e18d25d97014f59a7967d3145c13f39b2eb78190e12a6c7c3e19be52b21d17af58db8f11cb9eda0ff88a8d63863bf459298179e2cc9e224b79c8a7393db9c0

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -21,6 +21,8 @@ Or install it yourself as:
 Usage
 -----
 
+### Raw API
+
 In ruby script:
 
 ```ruby
@@ -30,7 +32,7 @@ md = <<EOM
 AWESOME SCRIPT
 ==============
 
-It's a wonderful markup languages!
+It's a wonderful markup language!
 
  * Markdown
  * reStructuredText
@@ -44,7 +46,7 @@ puts html
 # <h1>
 # <a name="awesome-script" class="anchor" href="#awesome-script"><span class="octicon octicon-link"></span></a>AWESOME SCRIPT</h1>
 # 
-# <p>It's a wonderful markup languages!</p>
+# <p>It's a wonderful markup language!</p>
 # 
 # <ul>
 # <li>Markdown</li>
@@ -59,7 +61,7 @@ In command-line:
 AWESOME SCRIPT
 ==============
 
-It's a wonderful markup languages!
+It's a wonderful markup language!
 
  * Markdown
  * reStructuredText
@@ -69,7 +71,7 @@ It's a wonderful markup languages!
 <h1>
 <a name="awesome-script" class="anchor" href="#awesome-script"><span class="octicon octicon-link"></span></a>AWESOME SCRIPT</h1>
 
-<p>It's a wonderful markup languages!</p>
+<p>It's a wonderful markup language!</p>
 
 <ul>
 <li>Markdown</li>
@@ -77,6 +79,10 @@ It's a wonderful markup languages!
 </ul>
 ```
 
+### Attr API
+
+
+
 ### Advansed
 
 ```

data/bin/github_markdown_api

@@ -2,4 +2,4 @@
 
 require 'github_markdown_api'
 
-puts GitHubMarkdownAPI::Client.new.raw(ARGF.read)
+puts GitHubMarkdownAPI::Raw::render(ARGF.read) rescue abort $!.inspect

data/github_markdown_api.gemspec

@@ -11,13 +11,14 @@ Gem::Specification.new do |spec|
   spec.description   = %q{GitHub Markdown API client and command-line tool}
   spec.summary       = %q{}
   spec.homepage      = "http://dt.zonu.me/"
-  spec.licenses      = %w[GPLv3 NYSL]
+  spec.licenses      = %w[LGPLv3 NYSL]
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'hashize'
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/github_markdown_api/api_client.rb

@@ -0,0 +1,111 @@
+require 'uri'
+require 'net/https'
+require 'github_markdown_api/version'
+
+# Abstract class of API Clients
+# @abstract
+class GitHubMarkdownAPI::APIClient
+  # @param [Hash,String] args
+  def initialize (args = {}, sub_args = {})
+    case args
+    when Hash
+      set_option args
+    when String
+      # pending
+    end
+  end
+
+  attr_reader :last_response
+
+  # @return [Symbol] Scheme of API
+  # @note `:http` of `:https`
+  attr_accessor :scheme
+
+  # @return [String] Hostname
+  attr_accessor :host
+
+  # @return [Fixnum] Port number
+  attr_accessor :port
+
+  # @return [Hash] Endpoint (Server path of API)
+  attr_accessor :endpoints
+
+  # @return [String] HTTP ContentType
+  attr_accessor :content_type
+
+  # @param  [Hash] args
+  # @return [self]
+  def set_option (args)
+    option = default_options.merge(args)
+    @scheme       = option[:scheme].intern
+    @host         = option[:host].to_s
+    @port         = option[:port]
+    @endpoints    = option[:endpoints].to_hash
+    @content_type = option[:content_type].to_s
+    return self
+  end
+
+  # Returns hash of default options
+  # @return [Hash]
+  def default_options
+    return {
+      scheme:       GitHubMarkdownAPI::DEFAULT_SCHEME,
+      host:         GitHubMarkdownAPI::DEFAULT_HOST,
+      port:         GitHubMarkdownAPI::DEFAULT_PORT,
+      endpoints:    GitHubMarkdownAPI::DEFAULT_ENDPOINTS,
+      auth:         GitHubMarkdownAPI::DEFAULT_AUTH,
+      content_type: GitHubMarkdownAPI::DEFAULT_CONTENT_TYPE,
+    }
+  end
+
+  # Requests API
+  # @param  [URI]    raw_uri
+  # @param  [Hash]   request
+  # @return [String]
+  def request (raw_uri, post)
+    http = Net::HTTP.new(raw_uri.host, raw_uri.port)
+    if @scheme == :https
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+
+    response = http.start{ http.request post }
+    @last_response = response
+
+    case response
+    when Net::HTTPSuccess
+      return response.body
+    else
+      raise RuntimeError, response
+    end
+  end
+
+  # Renders HTML from Markdown
+  # @param [String] markdown
+  # @abstract
+  def render (markdown)
+    raise NotImplementedError, "#{__method__} is a abstract method."
+  end
+
+  # Returns endpoint of API type
+  # @param  [Symbol,#to_sym] type
+  # @return [URI]
+  def endpoint (type)
+    path  = @endpoints[type.to_sym]
+    klass = case @scheme
+            when :http;  URI::HTTP
+            when :https; URI::HTTPS
+            end
+    param = {
+      host: @host,
+      path: path,
+    }
+    param[:port] = @port || 443
+
+    return  klass.build(param)
+  end
+
+  def self.render (markdown)
+    return self.new.render markdown
+  end
+end

data/lib/github_markdown_api/raw.rb

@@ -0,0 +1,20 @@
+require 'uri'
+require 'net/https'
+require 'github_markdown_api/version'
+require 'github_markdown_api/api_client'
+
+# Client implementation of Markdown Raw API
+class GitHubMarkdownAPI::Raw < GitHubMarkdownAPI::APIClient
+  # @param  [String] markdown
+  # @return [String]
+  def render (markdown)
+    raw_uri = endpoint(:raw)
+    header  = {
+      'Content-Type' => @content_type
+    }
+    post = Net::HTTP::Post.new(raw_uri, header)
+    post.body = markdown
+
+    return request(raw_uri, post)
+  end
+end

data/lib/github_markdown_api/version.rb

@@ -1,3 +1,5 @@
+# Namespace of github_markdown_api gem
 module GitHubMarkdownAPI
-  VERSION = '0.0.1'
+  # Version number of github_markdown_api gem
+  VERSION = '0.0.2'
 end

data/lib/github_markdown_api.rb

@@ -1,5 +1,5 @@
 require 'github_markdown_api/version'
-require 'github_markdown_api/client'
+require 'github_markdown_api/raw'
 
 module GitHubMarkdownAPI
   DEFAULT_SCHEME       = :https

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: github_markdown_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - USAMI Kenta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2014-01-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashize
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: GitHub Markdown API client and command-line tool
@@ -46,7 +60,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".yardopts"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -54,11 +69,12 @@ files:
 - bin/github_markdown_api
 - github_markdown_api.gemspec
 - lib/github_markdown_api.rb
-- lib/github_markdown_api/client.rb
+- lib/github_markdown_api/api_client.rb
+- lib/github_markdown_api/raw.rb
 - lib/github_markdown_api/version.rb
 homepage: http://dt.zonu.me/
 licenses:
-- GPLv3
+- LGPLv3
 - NYSL
 metadata: {}
 post_install_message: 
@@ -67,17 +83,17 @@ 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.0.6
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: ''

data/lib/github_markdown_api/client.rb

@@ -1,79 +0,0 @@
-require 'uri'
-require 'net/https'
-require 'github_markdown_api/version'
-
-class GitHubMarkdownAPI::Client
-  # @param [Hash] args
-  def initialize (args = {})
-    set_option args
-  end
-
-  attr_reader :last_response
-
-  def render
-    
-  end
-
-  # @param  [Hash] args
-  # @return []
-  def set_option (args)
-    option = default_options.merge(args)
-    @scheme       = option[:scheme].intern
-    @host         = option[:host].to_s
-    @port         = option[:port].to_i
-    @endpoints    = option[:endpoints].to_hash
-    @content_type = option[:content_type].to_s
-    return self
-  end
-
-  # @return [Hash]
-  def default_options
-    return {
-      scheme:       GitHubMarkdownAPI::DEFAULT_SCHEME,
-      host:         GitHubMarkdownAPI::DEFAULT_HOST,
-      port:         GitHubMarkdownAPI::DEFAULT_PORT,
-      endpoints:    GitHubMarkdownAPI::DEFAULT_ENDPOINTS,
-      auth:         GitHubMarkdownAPI::DEFAULT_AUTH,
-      content_type: GitHubMarkdownAPI::DEFAULT_CONTENT_TYPE,
-    }
-  end
-
-  # @param  [String] markdown
-  # @return [String]
-  def raw (markdown)
-    raw_uri = endpoint(:raw)
-    header  = {
-      'Content-Type' => @content_type
-    }
-    post = Net::HTTP::Post.new(raw_uri, header)
-    post.body = markdown
-
-    request = Net::HTTP.new(raw_uri.host, raw_uri.port)
-    if @scheme == :https
-      request.use_ssl = true
-      request.verify_mode = OpenSSL::SSL::VERIFY_PEER
-    end
-
-    response = request.start{|http| http.request(post) }
-    @last_response = response
-
-    case response
-    when Net::HTTPSuccess
-      return response.body
-    else
-      raise RuntimeError, response
-    end
-  end
-
-  # @param  [Symbol,#to_sym]
-  # @return [URI]
-  def endpoint(type)
-    path  = @endpoints[type.to_sym]
-    klass = case @scheme
-            when :http;  URI::HTTP
-            when :https; URI::HTTPS
-            end
-    uri = klass.build(host: @host, path: path, port: @port)
-    return uri
-  end
-end