syntaxdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 252da00c0dab99af01eb45a6822834c192b239dc
+  data.tar.gz: fd5bf36055596875432c9fad39c5b03957963075
+SHA512:
+  metadata.gz: e745d74913aa9e172737739416e057fb3617d2c69f5a9dd2c2707cd23771ec06083f8764da1ce83ee1cce3010fea4b7325233ffe4ab4361c35bc2196f1f5c080
+  data.tar.gz: 8c8b2152f901cff1c6c0ce2cd19ccc89dc3cbf54d0aebe4c8cb06587246c0fede6f0111ed8b3f41454cb02460d26c0f5e8f2a05fa7f74868e5fc847b176e4d56

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

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

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 lalithr95@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 syntaxdb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lalith
+
+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,82 @@
+# Syntaxdb
+
+Ruby client which supports SyntaxDB API. Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/syntaxdb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'syntaxdb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install syntaxdb
+
+## Usage
+
+`all()`
+The Languages endpoint returns all languages available on Syntaxdb, sorted by position by default. 
+
+**Parameter: fields, limit, sort**
+```ruby
+Syntaxdb::Language.all
+```
+
+`find()`
+Returns the language corresponding to the permalink along with its information.
+
+**Parameter: language_permalink(required), fields, limit, sort**
+```ruby
+Syntaxdb::Language.find({language_permalink: 'java'})
+```
+
+`find_categories()`
+The language categories endpoint returns all of the categories corresponding to the language.
+
+**Parameter: language_permalink(required), fields, limit, sort**
+```ruby
+Syntaxdb::Language.find_categories({
+    language_permalink: 'java'
+})
+```
+
+`find_concepts()`
+The category concepts endpoint returns all concepts belonging to the category, sorted by position by default.
+
+**Parameter: language_permalink(required), category_id(required), fields, limit, sort**
+```ruby
+Syntaxdb::Language.find_concepts({
+    language_permalink: 'java', 
+    category_id: 1
+})
+```
+
+`find_concepts()`
+The language concepts endpoint returns all concepts belonging to the language, sorted by position by default.
+
+**Parameter: language_permalink(required), fields, limit, sort**
+```ruby
+Syntaxdb::Language.find_concepts({ language_permalink: 'java' })
+```
+
+## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/syntaxdb. 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).

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 "syntaxdb"
+
+# 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

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/syntaxdb.rb

@@ -0,0 +1,5 @@
+require "syntaxdb/version"
+require "syntaxdb/category"
+require "syntaxdb/concept"
+require "syntaxdb/language"
+require "syntaxdb/request"

data/lib/syntaxdb/category.rb

@@ -0,0 +1,29 @@
+require 'syntaxdb/request'
+
+module Syntaxdb
+  class Category
+    attr_accessor :category_id
+    def initalize(category_id)
+      @category_id = category_id
+    end
+
+    class << self
+      def language_categories(options = {})
+        language_permalink = options[:language_permalink]
+        if language_permalink
+          Syntaxdb::Request.send_request(options, "/languages/#{language_permalink}/categories")
+        end
+      end
+
+      def concepts_category(options = {})
+        language_permalink = options[:language_permalink]
+        @category_id = options[:category_id]
+        if @category_id && language_permalink
+          Syntaxdb::Request.send_request(options, "/languages/#{language_permalink}/categories/#{category_id}/concepts")
+        end
+      end
+
+    end
+
+  end
+end

data/lib/syntaxdb/concept.rb

@@ -0,0 +1,63 @@
+require 'syntaxdb/request'
+
+module Syntaxdb
+  class Concept
+    attr_accessor :concept_id, :concept_permalink
+
+    def initialize(concept_id = nil, permalink = nil)
+      @concept_id = concept_id
+      @concept_permalink = permalink
+    end
+
+    class << self
+
+      def search
+      end
+
+      def all(options = {})
+        Syntaxdb::Request.send_request(options, '/concepts')
+      end
+
+      def find(options = {})
+        @concept_id = options[:concept_id]
+        if @concept_id
+          options.delete(:concept_id)
+          Syntaxdb::Request.send_request(options, "/concepts/#{@concept_id}")
+        end
+      end
+
+      def language_concepts(options = {})
+        @concept_permalink = options[:concept_permalink]
+        language_permalink = options[:language_permalink]
+        if language_permalink
+          options.delete(:language_permalink)
+          if @concept_permalink
+            options.delete(:concept_permalink)
+            Syntaxdb::Request.send_request(options, "/languages/#{language_permalink}/concepts/#{@concept_permalink}")
+          else
+            Syntaxdb::Request.send_request(options, "/languages/#{language_permalink}/concepts")
+          end
+        end
+      end
+
+      def search_concepts(options = {})
+        language_permalink = options[:language_permalink]
+        if language_permalink
+          options.delete(:language_permalink)
+          Syntaxdb::Request.send_request(options, "/languages/#{language_permalink}/concepts/search")
+        end
+      end
+
+      def find_category_concepts(options = {})
+        language_permalink = options[:language_permalink]
+        category_id = options[:category_id]
+        if language_permalink && category_id
+          options.delete(:category_id)
+          options.delete(:language_permalink)
+          Syntaxdb::Request.send_request(options, "/languages/#{language_permalink}/categories/#{category_id}/concepts")
+        end
+      end
+    end
+
+  end
+end

data/lib/syntaxdb/language.rb

@@ -0,0 +1,53 @@
+require 'syntaxdb/request'
+
+module Syntaxdb
+  class Language
+    attr_accessor :language_permalink
+
+    def initalize(language_permalink = nil)
+      @language_permalink = language_permalink
+    end
+    
+    class << self
+      def all(options = {})
+        Syntaxdb::Request.send_request(options, '/languages')
+      end
+
+      # params language_permalink
+      def find(options = {})
+        @language_permalink = options[:language_permalink]
+        if @language_permalink
+          options.delete(:language_permalink)
+          Syntaxdb::Request.send_request(options, "/languages/#{@language_permalink}")
+        end
+      end
+
+      # params language_permalink
+      # Find categories by language_permalink
+      def find_categories(options = {})
+        @language_permalink = options[:language_permalink]
+        if @language_permalink
+          options.delete(:language_permalink)
+          Syntaxdb::Request.send_request(options, "/languages/#{@language_permalink}/categories")
+        end
+      end
+
+      # Find concepts by language_permalink and category
+      def find_concepts(options = {})
+        @language_permalink = options[:language_permalink]
+        category_id = options[:category_id]
+        if @language_permalink
+          options.delete(:language_permalink)
+          if category_id
+            options.delete(:category_id)
+            Syntaxdb::Request.send_request(options, "/languages/#{@language_permalink}/categories/#{category_id}/concepts")
+          else
+            Syntaxdb::Request.send_request(options, "/languages/#{@language_permalink}/concepts")
+          end
+        end
+      end
+    
+    end
+
+  end
+end

data/lib/syntaxdb/request.rb

@@ -0,0 +1,33 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Syntaxdb
+  class Request
+    attr_accessor :api
+
+    def initalize
+      @api = "https://syntaxdb.com/api/v1"
+    end
+
+    def self.send_request(options = {}, endpoint)
+      @api = "https://syntaxdb.com/api/v1" if @api.nil?
+      url = @api + endpoint + "?"
+      options.each do |key, value|
+        url += key.to_s + "=" + value.to_s
+      end
+
+      uri = URI.parse(url)
+      header = {
+        'Content-Type' => 'text/json'
+      }
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri, header)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/syntaxdb/version.rb

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

data/syntaxdb.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'syntaxdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "syntaxdb"
+  spec.version       = Syntaxdb::VERSION
+  spec.authors       = ["Lalith"]
+  spec.email         = ["lalithr95@gmail.com"]
+
+  spec.summary       = %q{Ruby client which provides integration for SyntaxDB API}
+  spec.description   = %q{SyntaxDB allows users to search syntax of various languages. This gem will provide access to SyntaxDB apis in ruby}
+  spec.homepage      = "https://github.com/lalithr95/SyntaxDB"
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: syntaxdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lalith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-13 00:00:00.000000000 Z
+dependencies:
+- !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: 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: SyntaxDB allows users to search syntax of various languages. This gem
+  will provide access to SyntaxDB apis in ruby
+email:
+- lalithr95@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/syntaxdb.rb
+- lib/syntaxdb/category.rb
+- lib/syntaxdb/concept.rb
+- lib/syntaxdb/language.rb
+- lib/syntaxdb/request.rb
+- lib/syntaxdb/version.rb
+- syntaxdb.gemspec
+homepage: https://github.com/lalithr95/SyntaxDB
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby client which provides integration for SyntaxDB API
+test_files: []