api_url_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae092bf15142e19965454ff055d161cb539b92ef
+  data.tar.gz: 2e94fdd761fe31182c71befcd2e97af5cd5e0995
+SHA512:
+  metadata.gz: 3ca0963fe647a7aeeea388c982445ec906f3e92528de1d86a8cb3a4b1aba62e3f2c0f6dc07018a817f721d39f953b1e90605fc9e23893654e30e50dd7ca161e0
+  data.tar.gz: 61cb7afe695ea3652b81645aa62bc7c895d600c56a1403ecc37ba55b41e20a85b4d3551c8af4a8ec282f434d50825c3479eb85a7178b9fa1bb2c3e9d0544783e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api-url-generator.gemspec
+gemspec
+
+group :test do
+  gem "minitest"
+  gem "activerecord"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 M. A. Owens
+
+MIT License
+
+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,31 @@
+# API URL Generator
+
+After writing a few RESTful APIs with Rails, I was always running into issues with generating URL for my resources. Either, I would try to force `url_for` or `path_to` to work, but it was never ideal. Since, I couldn't find anyother solutions, I decide to write my own. This gem helps create urls for your RESTful API to make it easier for client applications to navigate without using `ActionView::Helpers`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_url_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_url_generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/api-url-generator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.ruby_opts = ['-r./test/test_helper.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/api_url_generator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_url_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_url_generator"
+  spec.version       = APIURLGenerator::VERSION
+  spec.authors       = ["M. A. Owens"]
+  spec.email         = ["matt@cremalab.com"]
+  spec.summary       = %q{
+      After writing a few RESTful APIs with Rails, I was always running into issues with generating URL for my resources.
+      Either, I would try to force `url_for` or `path_to` to work, but it was never ideal.
+      Since, I couldn't find any other solutions, I decide to write my own.
+      This gem helps create urls for your RESTful API to make it easier for client applications to navigate without using `ActionView::Helpers`
+  }
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/api_url_generator.rb

@@ -0,0 +1,50 @@
+require "api_url_generator/version"
+
+module APIURLGenerator
+  @@url
+
+  def self.url(x)
+    @@url = x
+  end
+
+  def self.get_url
+    @@url
+  end
+
+  def self.dectect_polymorphic(object)
+    object.instance_variables.each do |variable|
+      if variable.to_s[-9..-1] == "able_type"
+        return {
+          name: {variable.to_s[1..-1].to_sym => object.instance_eval(variable.to_s)},
+          id: {(variable.to_s[1..-5] + "id").to_sym => object.instance_eval(variable.to_s[1..-5] + "id")}
+        }
+      end
+    end
+
+    return false
+
+  end
+
+
+  def self.generate_url(object, nest = nil)
+    polymorphous = dectect_polymorphic(object)
+    if polymorphous && nest
+      nested_id = "/#{object.instance_eval(polymorphous[:name].keys[0].to_s).tableize.downcase}/#{object.instance_eval("#{polymorphous[:id].keys[0]}")}"
+      object_id = "/#{object.class.to_s.tableize.downcase}/#{object.id}"
+      if object.instance_eval(polymorphous[:name].keys[0].to_s).downcase != nest
+        raise ArgumentError, "Invalid nest param"
+      end
+      return "#{@@url}#{nested_id}#{object_id}"
+    elsif nest
+      begin
+        nested_id = "/#{nest.pluralize}/#{object.instance_eval("#{nest}_id")}"
+        object_id = "/#{object.class.to_s.tableize.downcase}/#{object.id}"
+        return "#{@@url}#{nested_id}#{object_id}"
+      rescue NameError
+        raise ArgumentError, "Invalid nest param"
+      end
+    else
+      return "#{@@url}/#{object.class.to_s.tableize.downcase}/#{object.id}"
+    end
+  end
+end

data/lib/api_url_generator/version.rb

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

data/test/api_url_generator_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+
+module APIURLGenerator
+  class APIURLGeneratorTest < Minitest::Test
+    def test_url_generator
+      object = Generic.new({
+        id: 5,
+        some_attribute: "This"
+      })
+      assert_equal "0.0.0.0:5000/generics/#{object.id}",
+                  APIURLGenerator.generate_url(object)
+
+    end
+
+    def test_url_generator_polymorphic
+      object = GenericPolymorphic.new({
+        polymorphicable_type: "Project",
+        polymorphicable_id: 22,
+        id: 33
+      })
+      assert_equal "0.0.0.0:5000/generic_polymorphics/#{object.id}",
+                  APIURLGenerator.generate_url(object)
+
+    end
+
+
+    def test_url_generator_nest
+      object = Generic.new({
+        id: 5,
+        some_attribute: "This",
+        project_id: 5
+      })
+
+      assert_equal "0.0.0.0:5000/projects/#{object.project_id}/generics/#{object.id}",
+                  APIURLGenerator.generate_url(object, "project")
+    end
+
+    def test_url_generator_nest_not_nested
+      object = Generic.new({
+        id: 5,
+        some_attribute: "This"
+      })
+
+      assert_raises(ArgumentError) do
+        APIURLGenerator.generate_url(object, "project_mm")
+      end
+
+    end
+
+
+    def test_polymorphous
+      object = GenericPolymorphic.new({
+        polymorphicable_type: "Project",
+        polymorphicable_id: 22,
+        id: 44
+
+      })
+      assert_equal "0.0.0.0:5000/projects/#{object.polymorphicable_id}/generic_polymorphics/#{object.id}",
+            APIURLGenerator.generate_url(object, "project")
+    end
+
+    def test_polymorphous_error
+      object = GenericPolymorphic.new({
+        polymorphicable_type: "Project",
+        polymorphicable_id: 22,
+        id: 44
+
+      })
+      assert_raises(ArgumentError) do
+        p APIURLGenerator.generate_url(object, "projectadfsd")
+      end
+    end
+
+
+    def test_dectect_polymorphic_true
+      object = GenericPolymorphic.new({
+        polymorphicable_type: "Project",
+        polymorphicable_id: 22,
+        id: 44
+      })
+
+      response = {
+        name: {polymorphicable_type: "Project"},
+        id: {polymorphicable_id: 22}
+      }
+
+      assert_equal response, APIURLGenerator.dectect_polymorphic(object)
+    end
+
+    def test_dectect_polymorphic_false
+      object = Generic.new({
+        id: 5,
+        some_attribute: "This",
+        project_id: 5
+      })
+
+      refute APIURLGenerator.dectect_polymorphic(object)
+    end
+
+  end
+end

data/test/models/generic_class.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+
+class Generic
+  extend ActiveModel::Naming
+  extend  ActiveModel::Translation
+
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+
+  attr_accessor :id, :some_attribute, :project_id
+
+  def initialize(attributes = {})
+    self.id = attributes[:id]
+    self.some_attribute = attributes[:some_attribute]
+    self.project_id = attributes[:project_id]
+  end
+
+end

data/test/models/generic_polymorphic_klass.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+
+class GenericPolymorphic
+  extend ActiveModel::Naming
+  extend  ActiveModel::Translation
+
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+
+  attr_accessor :id, :some_attribute, :polymorphicable_type, :polymorphicable_id
+
+  def initialize(attributes)
+    self.id = attributes[:id]
+    self.some_attribute = attributes[:some_attribute]
+    self.polymorphicable_type = attributes[:polymorphicable_type]
+    self.polymorphicable_id = attributes[:polymorphicable_id]
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'api_url_generator'
+require 'minitest/autorun'
+require 'models/generic_class'
+require 'models/generic_polymorphic_klass'
+
+module TestHelper
+  APIURLGenerator.url("0.0.0.0:5000")
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: api_url_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- M. A. Owens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: ''
+email:
+- matt@cremalab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_url_generator.gemspec
+- lib/api_url_generator.rb
+- lib/api_url_generator/version.rb
+- lib/generators/install/install_generator.rb
+- lib/generators/install/templates/api_url_generator.rb.erb
+- test/api_url_generator_test.rb
+- test/models/generic_class.rb
+- test/models/generic_polymorphic_klass.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: After writing a few RESTful APIs with Rails, I was always running into issues
+  with generating URL for my resources. Either, I would try to force `url_for` or
+  `path_to` to work, but it was never ideal. Since, I couldn't find any other solutions,
+  I decide to write my own. This gem helps create urls for your RESTful API to make
+  it easier for client applications to navigate without using `ActionView::Helpers`
+test_files:
+- test/api_url_generator_test.rb
+- test/models/generic_class.rb
+- test/models/generic_polymorphic_klass.rb
+- test/test_helper.rb