someapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f026e9cad3240ec1c275409e82272d601ca13230
+  data.tar.gz: e73c051d5f2eba1c9f10e90cc948365be6d9c05b
+SHA512:
+  metadata.gz: c64f30f3523c35d6604c939553a321faab0fc8b05f45c00ddd7fea0d8201a01c263a48186bc54dfec9f9d561c177e9ec22513bb47f030b2b96b7c5ee99b9854b
+  data.tar.gz: f97a01af2f90419dbe770d16e0e14c2ed75309e4717cc0d1751007e93d68111fbb35cb81b3c7494dd26f0fc14f928a206940b7113b6070a32c79a0c377fdf7c2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Smith
+
+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,80 @@
+# SomeAPI
+
+Built around HTTParty, SomeAPI provides a generic wrapper for your favourite RESTful WebAPI. Simply extend Some::API and apply your usual HTTParty options like base_uri, then call your new API and party harder!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'someapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install someapi
+
+## Party harder
+
+It's easier than 123!
+
+  1. Create your wrapper:
+
+        class Github < Some::API
+          base_uri 'https://api.github.com'
+          headers 'User-Agent' => 'p45-dashboard'
+          default_params 'client_id' => ENV['GITHUB_CLIENT_ID'],
+            'client_secret' => ENV['GITHUB_CLIENT_SECRET']
+          format :json
+        end
+
+  2. Start using it! Simply string method calls and subscripts together like it's a real API wrapper. Add a bang (`!`) at the end to initiate the HTTP request, returning an HTTParty response, so all your favourite HTTParty features are still intact. Party on!
+
+        github = Guthub.new
+        ...
+        github.get.users[@username].repos!
+        github.post.repos[@username][@repo].pulls! body: { title: "Foo", body: "Pull my Foo", ... }
+        github.delete.repos.[@username][@repo].!
+
+## Make a mockery of your tests
+
+Don't stub your toe on external services!
+
+  1. Add `gem 'webmock'` to your Gemfile under the test group
+
+  2. Add the following somewhere in your testing framework's configuration (like `spec_helper.rb`)
+
+        Some::API.include WebMock::API
+
+  3. Adding `stub` before the HTTP method in a SomeAPI request will instead return a Webmock stub after the bang.
+
+        github = Github.new
+        ...
+        github.stub.get.users[@username].repos!.
+          to_return status: 200, body: @somehash.to_json
+
+Stubs look exactly the same as their corresponding requests except for the presence of `stub`, so you can literally copy-pasta from your controllers to your specs and vice-versa without fiddling.
+
+## Tips and Gotchas
+
+If your request ends in a `[someth]` remember to put a dot before the bang, as in the examples. Ruby doesn't define the (very odd and mostly useless actually) operator for `[]!`.
+
+Posting hashes can be done more succinctly by using the `<<` operator, as follows (using the post example from above):
+
+    github.post.repos[@username][@repo].pulls << { title: "Foo", body: "Pull my Foo", ... }
+
+Also note that every time you do this (put the bang at the beginning of a request):
+
+    !github.get.users[@some_user]
+
+a baby seal/platypus/kitten will die a horrific death. Also, it looks really bad and will confuse the crap out of you and your peers.
+
+## Thank you for helping us help you help us all
+
+1. Fork it ( https://github.com/[my-github-username]/someapi/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/someapi/version.rb

@@ -0,0 +1,3 @@
+module Some
+  VERSION = "0.0.1"
+end

data/lib/someapi.rb

@@ -0,0 +1,135 @@
+require "someapi/version"
+
+require 'httparty'
+
+module Some
+
+  class API
+    include HTTParty
+
+    API_REGEX = /^[a-zA-Z0-9_]+[!]?$/
+
+    def initialize options={}, meth=nil, path=nil, stubbed=false
+      @meth = meth
+      @path = path
+      @options = options
+
+      # stubbed is a flag set when you're stubbing the API call
+      # used in testing
+      # just call 'stub' in the call chain before the http_method method
+      @stubbed = stubbed
+    end
+
+    # http_method methods
+    # used in the call chain to set the http method
+    %W(get post put patch delete copy move head options).each do |meth|
+      define_method(meth) do
+        unless @meth
+          self.class.new Hash.new, meth.to_s, nil, @stubbed
+        else
+          self[meth]
+        end
+      end
+    end
+
+    # use in the call chain to flag this request as a stub
+    # used in testing for setting up API-call stubs
+    def stub
+      unless @meth
+        self.class.new Hash.new, @meth, @path, true
+      else
+        self['stub']
+      end
+    end
+
+    # sort of an alias for 'posting' (or whatever) an object
+    # just syntactic sugar for {body: obj} really
+    # I would have used '=' but that would return the object you posted! >.<
+    def << obj
+      self.! body: obj
+    end
+
+    # seriously this could be alias_method :>>, :!
+    def >> options
+      self.! options
+    end
+
+    # 'calls' the API request
+    # (or makes the stub, if stubbed)
+    def ! options = {}
+      unless @stubbed
+        self.class.send(@meth, @path || '/', deep_merge(options,@options))
+      else
+        uri = "#{self.class.base_uri}#{@path}"
+
+        deep_merge(options,@options)
+        process_headers(options)
+        process_query(options)
+        options = self.class.default_options.
+          merge(@options.merge(options))
+
+        stub_request(@meth.to_sym, uri.to_s).with(options)
+      end
+    end
+
+    # chains 'thing' onto URL path
+    def [] thing
+      self.class.new @options, @meth, "#{@path || ''}/#{thing}", @stubbed
+    end
+
+    # this is where the fun begins...
+    def method_missing meth, *args, &block
+      meths = meth.to_s
+      if @meth && meths =~ API_REGEX
+
+        if meths.end_with?('!')
+          # `foo! bar' is syntactic sugar for `foo.! bar'
+          self[meths[0...-1]].!(args[0] || {})
+
+        else
+          # chain the method name onto URL path
+          self[meths]
+        end
+      else
+        super
+      end
+    end
+
+    def respond_to_missing? meth
+      @meth && meth.to_s =~ API_REGEX
+    end
+
+    private
+
+      # shamelessly stolen from HTTParty
+      def process_headers(options)
+        if options[:headers] && self.class.headers.any?
+          options[:headers] = self.class.headers.merge(options[:headers])
+        end
+      end
+
+      # shamelessly copied from above, but for :query
+      def process_query(options)
+        if self.class.default_options[:default_params]
+          options[:query] = self.class.default_options[:default_params].
+            merge(options[:query] || {})
+        end
+      end
+
+      # merge a hash within a hash from two hashes (yo-dawg...)
+      def merge_stuff(a,b,tag)
+        if a[tag] && b[tag]
+          a[tag] = b[tag].merge(a[tag])
+        end
+      end
+
+      # just merge_stuff like :headers and :query... you know, HTTP stuff
+      def deep_merge(a,b)
+        merge_stuff(a,b,:headers)
+        merge_stuff(a,b,:query)
+        b.merge(a)
+      end
+
+  end
+
+end

data/someapi.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'someapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "someapi"
+  spec.version       = Some::VERSION
+  spec.authors       = ["Daniel Smith"]
+  spec.email         = ["jellymann@gmail.com"]
+  spec.summary       = %q{A generic RESTful API wrapper.}
+  spec.description   = %q{Built around HTTParty, SomeAPI provides a generic wrapper for your favourite RESTful WebAPI. Simply extend Some::API and apply your usual HTTParty options like base_uri, then call your new API and party harder!}
+  spec.homepage      = "https://github.com/jellymann/someapi"
+  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_runtime_dependency "httparty", "~> 0.13.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: someapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: Built around HTTParty, SomeAPI provides a generic wrapper for your favourite
+  RESTful WebAPI. Simply extend Some::API and apply your usual HTTParty options like
+  base_uri, then call your new API and party harder!
+email:
+- jellymann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/someapi.rb
+- lib/someapi/version.rb
+- someapi.gemspec
+homepage: https://github.com/jellymann/someapi
+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.3.0
+signing_key: 
+specification_version: 4
+summary: A generic RESTful API wrapper.
+test_files: []