grammer 0.2.1.edge → 0.2.3.edge

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5859b926ee38745c21ad36c2cac29e3458c6ae62
-  data.tar.gz: 1c84b880ee2e0dfee69e12a464d8e759d588938b
+  metadata.gz: 3ea42af8ecb0f495ad1f5e83707eed9a7a0c9cae
+  data.tar.gz: d86e6a3de1e8a97351c29a713a1b4118b20c20b6
 SHA512:
-  metadata.gz: f11bbbfe6131d6ff983cc3b1e4b125ec19fa656e137a24ceb17e69ad7892a586a26b25158c203e249bebd75d4d2cfd8a9a8f3b524c499e694da2e2d637263c6a
-  data.tar.gz: f2a7a2a063bb266788924004a9c3728f234cdd76f476ac9c8831ca28790b645e17714ea19de836db8319d2240d2e9dcb9c6b22901b41d7993b9bf289d304de39
+  metadata.gz: dbcffea118ae4c2ed70f95d36058b58887f9c2452b29485e3ac9da198b4a9107d73cb205900c36db347c8d30d13bd0eb4de52a706d7ce4d3f08dc53795467f56
+  data.tar.gz: 4ba1bb4abc6eee42796f1fc4b6dc86b521fe154b6c8b69d2abb114985a030d414456e210374e7319c5a950ed795e4fabb03d26a28b8cd57fc8fbc23a1b560b1e

data/README.md

@@ -0,0 +1,43 @@
+[![Gem Version](https://badge.fury.io/rb/grammer.svg)](https://badge.fury.io/rb/grammer)
+[![Maintainability](https://api.codeclimate.com/v1/badges/57a19b2186210fd18d19/maintainability)](https://codeclimate.com/github/caioertai/grammer/maintainability)
+[![Build Status](https://travis-ci.org/caioertai/grammer.svg?branch=master)](https://travis-ci.org/caioertai/grammer)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Grammer
+========
+
+**Connect objects to Instagram account info.**
+
+Key features:
+
+* Can be included in objects.
+* On one request:
+  * Gets the public info of a provided username (except for followers).
+  * Text, link and caption of latest 12 medias.
+
+Compatibility:
+
+* Work in progress
+
+
+Incluing Grammer in Objects
+-----------------
+
+To include Grammer you model must implement a method that returns an Instagram username:
+
+**1.** Your model must provide a method that returns an Instagram username.
+
+**2.** In your model, tell grammer where to find the Instagram username and on which method to provide the data:
+
+    grammed_by :username, on: :ig
+
+**3.** This allows you to call `#ig` on your object to retrieve its Instagram info.
+
+TODO
+------------
+* Finish documentation.
+* Command line interface
+* Media objects
+* RDOCs
+
+Copyright (c) 2019 Caio Andrade, released under the MIT license.

data/lib/grammer/macro_handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Grammer
+  ##
+  # Build procs for singleton method definitions
+  class MacroHandler
+    DEFINE = proc do |method_name, options|
+      define_method(options[:on]) do
+        instance_variable_name = "@#{options[:on]}"
+        if instance_variable_defined?(instance_variable_name)
+          instance_variable_get(instance_variable_name)
+        else
+          node = Node.new(send(method_name), service: options[:service])
+          instance_variable_set(instance_variable_name, node)
+        end
+      end
+    end
+  end
+end

data/lib/grammer/macros.rb

@@ -15,23 +15,6 @@ module Grammer
       end
     end
 
-    ##
-    # Defines methods on singleton modules in order to handle macros
-    def define_module_method(mod, method_name, opts)
-      mod.class_eval do
-        target_attribute = opts[:on]
-        define_method(target_attribute) do
-          instance_variable_name = "@#{target_attribute}"
-          if instance_variable_defined?(instance_variable_name)
-            instance_variable_get(instance_variable_name)
-          else
-            node = Node.new(send(method_name), service: opts[:service])
-            instance_variable_set(instance_variable_name, node)
-          end
-        end
-      end
-    end
-
     ##
     # Main initializing class macro for the module.
     # Defines a Node instance on the given name.
@@ -40,5 +23,11 @@ module Grammer
       define_module_method(mod, method_name, opts)
       prepend mod
     end
+
+    private
+
+    def define_module_method(mod, method_name, opts)
+      mod.class_exec(method_name, opts, &Grammer::MacroHandler::DEFINE)
+    end
   end
 end

data/lib/grammer/node.rb

@@ -20,6 +20,12 @@ module Grammer
       @data    = service.node(username)
     end
 
+    ##
+    # Helper for displaying node's id
+    def id
+      @data.dig('id')
+    end
+
     ##
     # Helper for displaying node's biography
     def biography

data/lib/grammer/version.rb

@@ -7,7 +7,7 @@ module Grammer
   module VERSION
     MAJOR = 0
     MINOR = 2
-    PATCH = 1
+    PATCH = 3
     BUILD = 'edge'
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/grammer.rb

@@ -8,10 +8,17 @@ module Grammer
 
   require 'grammer/ig_service'
   require 'grammer/macros'
+  require 'grammer/macro_handler'
   require 'grammer/node'
 
   ##
-  # Extends class macros to main module 
+  # Initializes a node with a given username
+  def self.node(username)
+    Node.new(username)
+  end
+
+  ##
+  # Extends class macros to main module
   def self.included(klass)
     klass.extend(Macros)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grammer
 version: !ruby/object:Gem::Version
-  version: 0.2.1.edge
+  version: 0.2.3.edge
 platform: ruby
 authors:
 - Caio Andrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -134,7 +134,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.1
-description: Provides a simple way to connect objects to the info on a Instagram account.
+description: "    Provides a simple way to connect objects to the info on a Instagram
+  account.'\n"
 email: caioertai@gmail.com
 executables: []
 extensions: []
@@ -144,10 +145,11 @@ files:
 - README.md
 - lib/grammer.rb
 - lib/grammer/ig_service.rb
+- lib/grammer/macro_handler.rb
 - lib/grammer/macros.rb
 - lib/grammer/node.rb
 - lib/grammer/version.rb
-homepage: http://rubygems.org/gems/grammer
+homepage: https://github.com/caioertai/grammer
 licenses:
 - MIT
 metadata: {}