forward-slash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9047ff27e33ef18ea9f4f9dc2528abf6260970cf
+  data.tar.gz: fa7c3431bbaded3158c2eb6f36ba855fd5d9a136
+SHA512:
+  metadata.gz: dca28114a6cd60f4ec9a3e3462a1bf3a3b740f809b19d54a4a15a4bff15437768c26381ffe54a8f86fafdbe69aad321e672a177f1349a54a8fcccfe8ee761a00
+  data.tar.gz: 876297fd2af8c800f7be3822a70f67fe78c9a28f8682bf7b46b08ebc418178e11a4f17d7f825345b736f54dd1fa2527bb198c52e1c0be28dc562267f0130583e

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle
+spec/examples.txt
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    forward-slash (0.0.1)
+      binding_of_caller (~> 0.7.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    debug_inspector (0.0.2)
+    diff-lcs (1.2.5)
+    hashdiff (0.3.0)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    webmock (1.22.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  forward-slash!
+  pry (~> 0.10.1)
+  rspec (~> 3.4.0)
+  webmock (~> 1.22.6)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © 2016 Chris Sinjakli
+
+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,49 @@
+# ForwardSlash
+
+An HTTP client with REST literals
+
+# Description
+
+ForwardSlash makes REST a first-class citizen of the Ruby programming language. Rather than forcing developers to write code that makes calls to URLs over HTTP, ForwardSlash lets you drop the URL right in your code - no more worrying about what HTTP is. [This blog post](http://blog.sinjakli.co.uk/2016/04/04/forwardslash-taking-back-the-restful-operator/) explains it best.
+
+# Getting started
+
+Install the gem:
+
+```
+gem install forward-slash
+```
+
+Then include the `ForwardSlash` module in a class you want to make HTTP calls from, and you're good to go! Here's a runnable example (taken from the `examples` folder):
+
+```ruby
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift 'lib'
+require "bundler"
+Bundler.require
+
+class CurrentIp
+  include ForwardSlash
+
+  def self.print
+    http://ifconfig.me/ip
+    puts result
+  end
+end
+
+CurrentIp.print
+```
+
+# Limitations
+
+Anything that isn't valid Ruby syntax is unsupported, including:
+
+  - Query strings
+  - Trailing slashes on URLs
+
+# Should I use this?
+
+\#yeauxleaux
+
+![I regret nothing](https://i.imgur.com/27UuUwL.gif)

data/examples/print_current_ip

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift 'lib'
+require "bundler"
+Bundler.require
+
+class CurrentIp
+  include ForwardSlash
+
+  def self.print
+    http://ifconfig.me/ip
+    puts result
+  end
+end
+
+CurrentIp.print

data/forward-slash.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "forward_slash/version"
+
+Gem::Specification.new do |s|
+  s.name          = "forward-slash"
+  s.version       = ForwardSlash::VERSION
+  s.date          = "2016-04-04"
+  s.summary       = "An HTTP client with REST literals"
+  s.description   = <<-EOF
+ForwardSlash makes REST a first-class citizen of the Ruby programming language.
+Rather than forcing developers to write code that makes calls to URLs over HTTP,
+ForwardSlash lets you drop the URL right in your code - no more worrying about
+what HTTP is.
+
+This blog post explains it best: http://blog.sinjakli.co.uk/2016/04/04/forwardslash-taking-back-the-restful-operator/
+EOF
+  s.authors       = ["Chris Sinjakli"]
+  s.email         = "chris@sinjakli.co.uk"
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.homepage      = "https://github.com/sinjo/forward-slash"
+  s.license       = "MIT"
+
+  s.add_dependency "binding_of_caller", "~> 0.7.2"
+
+  s.add_development_dependency "pry", "~> 0.10.1"
+  s.add_development_dependency "rspec", "~> 3.4.0"
+  s.add_development_dependency "webmock", "~> 1.22.6"
+end

data/lib/forward_slash.rb

@@ -0,0 +1,30 @@
+require "binding_of_caller"
+require "forward_slash/core_ext/symbol"
+require "forward_slash/domain_part"
+
+module ForwardSlash
+  def self.included(base)
+    base.send(:attr_reader, :result)
+    base.define_singleton_method(:result) do
+      @result
+    end
+
+    base.extend self
+  end
+
+  def http(url)
+    result = Net::HTTP.get(URI("http://#{url.part}"))
+    calling_object = binding.of_caller(1).receiver
+    calling_object.instance_variable_set(:@result, result)
+  end
+
+  def https(url)
+    result = Net::HTTP.get(URI("https://#{url.part}"))
+    calling_object = binding.of_caller(1).receiver
+    calling_object.instance_variable_set(:@result, result)
+  end
+
+  def method_missing(part, *args)
+    DomainPart.new(part.to_s)
+  end
+end

data/lib/forward_slash/core_ext/symbol.rb

@@ -0,0 +1,5 @@
+class Symbol
+  def /(other)
+    other
+  end
+end

data/lib/forward_slash/domain_part.rb

@@ -0,0 +1,26 @@
+require "net/http"
+
+module ForwardSlash
+  class DomainPart
+    attr_reader :part
+
+    def initialize(part)
+      @part = part
+    end
+
+    def -(other)
+      @part += "-#{other.part}"
+      self
+    end
+
+    def /(other)
+      @part += "/#{other.part}"
+      self
+    end
+
+    def method_missing(next_domain_part, *args)
+        @part += ".#{next_domain_part.to_s}"
+      self
+    end
+  end
+end

data/lib/forward_slash/version.rb

@@ -0,0 +1,3 @@
+module ForwardSlash
+  VERSION = "1.0.0"
+end

data/spec/forward_slash_spec.rb

@@ -0,0 +1,73 @@
+require "forward_slash"
+
+RSpec.describe ForwardSlash do
+  let(:fetcher) {
+    Class.new do
+      include ForwardSlash
+
+      def initialize(url)
+        @url = url
+      end
+
+      def test_fetch
+        eval @url
+        result
+      end
+
+      def self.test_fetch(url)
+        eval url
+        result
+      end
+    end
+  }
+
+  shared_examples_for "performing HTTP requests" do
+    context "in instance methods" do
+      it "fetches the page and saves the result" do
+        expect(fetcher.new(url).test_fetch).to eq(response)
+      end
+    end
+
+    context "in class methods" do
+      it "fetches the page and saves the result" do
+        expect(fetcher.test_fetch(url)).to eq(response)
+      end
+    end
+  end
+
+  shared_examples_for "different URL structures" do
+    let(:url) { "#{scheme}://example.com" }
+
+    include_examples "performing HTTP requests"
+
+    context "with a hyphen" do
+      let(:url) { "#{scheme}://exa-mple.com" }
+
+      include_examples "performing HTTP requests"
+    end
+
+    context "with a path after the domain" do
+      let(:url) { "#{scheme}://example.com/foo" }
+
+      include_examples "performing HTTP requests"
+    end
+  end
+
+  let(:response) { "Hello" }
+
+  before do
+    stub_request(:get, url).to_return(body: response)
+  end
+
+  context "for plain HTTP" do
+    let(:scheme) { "http" }
+
+    include_examples "different URL structures"
+  end
+
+  context "for HTTPS" do
+    let(:scheme) { "https" }
+
+    include_examples "different URL structures"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+require "webmock/rspec"
+
+WebMock.disable_net_connect!
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+=end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: forward-slash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Sinjakli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+description: |
+  ForwardSlash makes REST a first-class citizen of the Ruby programming language.
+  Rather than forcing developers to write code that makes calls to URLs over HTTP,
+  ForwardSlash lets you drop the URL right in your code - no more worrying about
+  what HTTP is.
+
+  This blog post explains it best: http://blog.sinjakli.co.uk/2016/04/04/forwardslash-taking-back-the-restful-operator/
+email: chris@sinjakli.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- examples/print_current_ip
+- forward-slash.gemspec
+- lib/forward_slash.rb
+- lib/forward_slash/core_ext/symbol.rb
+- lib/forward_slash/domain_part.rb
+- lib/forward_slash/version.rb
+- spec/forward_slash_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sinjo/forward-slash
+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.1
+signing_key: 
+specification_version: 4
+summary: An HTTP client with REST literals
+test_files: []